Azure.ResourceManager.Synapse.Models Namespace

Classes

ArmSynapseModelFactory	Model factory for models.
BigDataPoolAutoPauseProperties	Auto-pausing properties of a Big Data pool powered by Apache Spark.
BigDataPoolAutoScaleProperties	Auto-scaling properties of a Big Data pool powered by Apache Spark.
BigDataPoolLibraryInfo	Library/package information of a Big Data pool powered by Apache Spark.
BigDataPoolLibraryRequirements	Library requirements for a Big Data pool powered by Apache Spark.
BigDataPoolSparkConfigProperties	SparkConfig Properties for a Big Data pool powered by Apache Spark.
IntegrationRuntimeRegenerateKeyContent	Parameters to regenerate the authentication key.
KekIdentityProperties	Key encryption key properties.
KustoPoolChildResourceNameAvailabilityContent	The result returned from a database check name availability request.
KustoPoolDatabasePrincipalAssignmentNameAvailabilityContent	A principal assignment check name availability request.
KustoPoolDataConnectionNameAvailabilityContent	A data connection check name availability request.
KustoPoolNameAvailabilityContent	The object sent for a kusto pool check name availability request.
KustoPoolNameAvailabilityResult	The result returned from a check name availability request.
KustoPoolPrincipalAssignmentNameAvailabilityContent	A principal assignment check name availability request.
KustoPoolSkuDescription	The Kusto SKU description of given resource type.
KustoPoolSkuLocationInfoItem	The locations and zones info for SKU.
PrivateEndpointConnectionForPrivateLinkHubBasic	The PrivateEndpointConnectionForPrivateLinkHubBasic.
ReplaceAllFirewallRulesOperationResult	An existing operation for replacing the firewall rules.
ReplaceAllIPFirewallRulesContent	Replace all IP firewall rules request.
SqlPoolCreateRestorePointContent	Contains the information necessary to perform a create Sql pool restore point operation.
SqlPoolUsage	The Sql pool usages.
SqlPoolVulnerabilityAssessmentRuleBaselineItem	Properties for an Sql pool vulnerability assessment rule baseline's result.
SqlPoolVulnerabilityAssessmentScansExport	A Sql pool Vulnerability Assessment scan export resource.
SynapseBigDataPoolInfoPatch	Properties patch for a Big Data pool.
SynapseCmdkeySetup	The custom setup of running cmdkey commands.
SynapseComponentSetup	The custom setup of installing 3rd party components.
SynapseCustomSetupBase	The base definition of the custom setup. Please note SynapseCustomSetupBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SynapseCmdkeySetup, SynapseComponentSetup and SynapseEnvironmentVariableSetup.
SynapseDataConnectionValidation	Class representing an data connection validation.
SynapseDataConnectionValidationListResult	The list Kusto data connection validation result.
SynapseDataConnectionValidationResult	The result returned from a data connection validation request.
SynapseDataLakeStorageAccountDetails	Details of the data lake storage account associated with the workspace.
SynapseDataSourceCapacity	Azure capacity definition.
SynapseDataSourceResourceSku	Azure resource SKU definition.
SynapseDataSourceSku	Azure SKU definition.
SynapseDynamicExecutorAllocation	Dynamic Executor Allocation Properties.
SynapseEncryptionDetails	Details of the encryption associated with the workspace.
SynapseEntityReference	The entity reference.
SynapseEnvironmentVariableSetup	The custom setup of setting environment variable.
SynapseEventGridDataConnection	Class representing an Event Grid data connection.
SynapseEventHubDataConnection	Class representing an event hub data connection.
SynapseFollowerDatabaseDefinition	A class representing follower database request.
SynapseGetSsisObjectMetadataContent	The request payload of get SSIS object metadata.
SynapseGrantSqlControlToManagedIdentity	Grant sql control to managed identity.
SynapseIntegrationRuntimeAuthKeys	The integration runtime authentication keys.
SynapseIntegrationRuntimeComputeProperties	The compute resource properties for managed integration runtime.
SynapseIntegrationRuntimeConnectionInfo	Connection information for encrypting the on-premises data source credentials.
SynapseIntegrationRuntimeCustomSetupScriptProperties	Custom setup script properties for a managed dedicated integration runtime.
SynapseIntegrationRuntimeDataFlowProperties	Data flow properties for managed integration runtime.
SynapseIntegrationRuntimeDataProxyProperties	Data proxy properties for a managed dedicated integration runtime.
SynapseIntegrationRuntimeMonitoringResult	Get monitoring data response.
SynapseIntegrationRuntimeNodeIPAddress	The IP address of self-hosted integration runtime node.
SynapseIntegrationRuntimeNodeMonitoringResult	Monitoring data for integration runtime node.
SynapseIntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint	Azure-SSIS integration runtime outbound network dependency endpoints for one category.
SynapseIntegrationRuntimeOutboundNetworkDependenciesEndpoint	The endpoint for Azure-SSIS integration runtime outbound network dependency.
SynapseIntegrationRuntimeOutboundNetworkDependenciesEndpointDetails	The details of Azure-SSIS integration runtime outbound network dependency endpoint.
SynapseIntegrationRuntimePatch	Update integration runtime request.
SynapseIntegrationRuntimeProperties	Azure Synapse nested object which serves as a compute resource for activities. Please note SynapseIntegrationRuntimeProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SynapseManagedIntegrationRuntime and SynapseSelfHostedIntegrationRuntime.
SynapseIntegrationRuntimeSsisCatalogInfo	Catalog information for managed dedicated integration runtime.
SynapseIntegrationRuntimeSsisProperties	SSIS properties for managed integration runtime.
SynapseIntegrationRuntimeStatus	Integration runtime status. Please note SynapseIntegrationRuntimeStatus is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SynapseManagedIntegrationRuntimeStatus and SynapseSelfHostedIntegrationRuntimeStatus.
SynapseIntegrationRuntimeStatusResult	Integration runtime status response.
SynapseIntegrationRuntimeVnetProperties	VNet properties for managed integration runtime.
SynapseIotHubDataConnection	Class representing an iot hub data connection.
SynapseIPFirewallRuleProperties	IP firewall rule properties.
SynapseKustoPoolPatch	Class representing an update to a Kusto kusto pool.
SynapseKustoPoolPrivateLinkData	Class representing a Private Link Resources.
SynapseLanguageExtension	The language extension object.
SynapseLanguageExtensionsList	The list of language extension objects.
SynapseLinkedIntegrationRuntime	The linked integration runtime information.
SynapseLinkedIntegrationRuntimeKeyAuthorization	The key authorization type integration runtime.
SynapseLinkedIntegrationRuntimeRbacAuthorization	The role based access control (RBAC) authorization type integration runtime.
SynapseLinkedIntegrationRuntimeType	The base definition of a linked integration runtime. Please note SynapseLinkedIntegrationRuntimeType is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SynapseLinkedIntegrationRuntimeKeyAuthorization and SynapseLinkedIntegrationRuntimeRbacAuthorization.
SynapseMaintenanceWindowTimeRange	Maintenance window time range.
SynapseManagedIntegrationRuntime	Managed integration runtime, including managed elastic and managed dedicated integration runtimes.
SynapseManagedIntegrationRuntimeError	Error definition for managed integration runtime.
SynapseManagedIntegrationRuntimeNode	Properties of integration runtime node.
SynapseManagedIntegrationRuntimeOperationResult	Properties of managed integration runtime operation result.
SynapseManagedIntegrationRuntimeStatus	Managed integration runtime status.
SynapseManagedVirtualNetworkSettings	Managed Virtual Network Settings.
SynapseOptimizedAutoscale	A class that contains the optimized auto scale definition.
SynapsePrivateEndpointConnectionProperties	Properties of a private endpoint connection.
SynapsePrivateLinkHubPatch	PrivateLinkHub patch details.
SynapsePrivateLinkResourceProperties	Properties of a private link resource.
SynapsePrivateLinkServiceConnectionState	Connection state details of the private endpoint.
SynapseReadOnlyFollowingDatabase	Class representing a read only following database.
SynapseReadWriteDatabase	Class representing a read write database.
SynapseRecommendedSensitivityLabelUpdate	A recommended sensitivity label update operation.
SynapseRecommendedSensitivityLabelUpdateOperationListResult	A list of recommended sensitivity label update operations.
SynapseResourceMoveDefinition	Contains the information necessary to perform a resource move (rename).
SynapseSecretBase	The base definition of a secret type. Please note SynapseSecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SynapseSecureString.
SynapseSecureString	Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.
SynapseSelfHostedIntegrationRuntime	Self-hosted integration runtime.
SynapseSelfHostedIntegrationRuntimeNode	Properties of Self-hosted integration runtime node.
SynapseSelfHostedIntegrationRuntimeStatus	Self-hosted integration runtime status.
SynapseSensitivityLabelUpdate	A sensitivity label update operation.
SynapseSensitivityLabelUpdateListResult	A list of sensitivity label update operations.
SynapseServerUsage	Represents server metrics.
SynapseSku	SQL pool SKU.
SynapseSqlPoolPatch	A SQL Analytics pool patch info.
SynapseSsisEnvironment	Ssis environment.
SynapseSsisEnvironmentReference	Ssis environment reference.
SynapseSsisFolder	Ssis folder.
SynapseSsisObjectMetadata	SSIS object metadata. Please note SynapseSsisObjectMetadata is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SynapseSsisEnvironment, SynapseSsisFolder, SynapseSsisPackage and SynapseSsisProject.
SynapseSsisObjectMetadataStatusResult	The status of the operation.
SynapseSsisPackage	Ssis Package.
SynapseSsisParameter	Ssis parameter.
SynapseSsisProject	Ssis project.
SynapseSsisVariable	Ssis variable.
SynapseTableLevelSharingProperties	Tables that will be included and excluded in the follower database.
SynapseVulnerabilityAssessmentRecurringScansProperties	Properties of a Vulnerability Assessment recurring scans.
SynapseVulnerabilityAssessmentScanError	Properties of a vulnerability assessment scan error.
SynapseWorkspaceKeyDetails	Details of the customer managed key associated with the workspace.
SynapseWorkspacePatch	Workspace patch details.
SynapseWorkspaceRepositoryConfiguration	Git integration settings.
UpdateIntegrationRuntimeNodeContent	Update integration runtime node request.
WorkspaceCustomerManagedKeyDetails	Details of the customer managed key associated with the workspace.

Structs

AadAuthenticationState	property configuration state.
BigDataPoolNodeSize	The level of compute power that each node in the Big Data pool has.
BigDataPoolNodeSizeFamily	The kind of nodes that the Big Data pool provides.
KustoPoolCompressionType	The compression type.
KustoPoolNameUnavailableReason	Message providing the reason why the given name is invalid.
KustoPoolSkuSize	SKU size.
KustoPoolState	The state of the resource.
KustoPoolType	The type of resource, Microsoft.Synapse/workspaces/kustoPools.
ResourceProvisioningState	The provisioned state of the resource.
SqlPoolColumnDataType	The column data type.
SqlPoolConnectionPolicyName	The SqlPoolConnectionPolicyName.
SqlPoolCreateMode	Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified.
SqlPoolSecurityAlertPolicyName	The SqlPoolSecurityAlertPolicyName.
SqlPoolStorageAccountType	The storage account type used to store backups for this sql pool.
SqlServerSecurityAlertPolicyName	The SqlServerSecurityAlertPolicyName.
SynapseAadOnlyAuthenticationName	The SynapseAadOnlyAuthenticationName.
SynapseBlobAuditingPolicyName	The SynapseBlobAuditingPolicyName.
SynapseBlobStorageEventType	The name of blob storage event type to process.
SynapseClusterPrincipalRole	Cluster principal role.
SynapseDatabasePrincipalAssignmentType	The type of resource, Microsoft.Synapse/workspaces/kustoPools/databases/principalAssignments.
SynapseDatabasePrincipalRole	Database principal role.
SynapseDataConnectionType	The type of resource, Microsoft.Synapse/workspaces/kustoPools/databases/dataConnections.
SynapseDataFlowComputeType	Compute type of the cluster which will execute data flow job.
SynapseDataSourceScaleType	Scale type.
SynapseDataWarehouseUserActivityName	The SynapseDataWarehouseUserActivityName.
SynapseDayOfWeek	Day of maintenance window.
SynapseDedicatedSqlMinimalTlsSettingName	The SynapseDedicatedSqlMinimalTlsSettingName.
SynapseDefaultPrincipalsModificationKind	The default principals modification kind.
SynapseEncryptionProtectorName	The SynapseEncryptionProtectorName.
SynapseEventGridDataFormat	The data format of the message. Optionally the data format can be added to each message.
SynapseEventHubDataFormat	The data format of the message. Optionally the data format can be added to each message.
SynapseGeoBackupPolicyName	The SynapseGeoBackupPolicyName.
SynapseIntegrationRuntimeAuthKeyName	The name of the authentication key to regenerate.
SynapseIntegrationRuntimeAutoUpdate	The state of integration runtime auto update.
SynapseIntegrationRuntimeEdition	The edition for the SSIS Integration Runtime.
SynapseIntegrationRuntimeEntityReferenceType	The type of this referenced entity.
SynapseIntegrationRuntimeInternalChannelEncryptionMode	It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).
SynapseIntegrationRuntimeLicenseType	License type for bringing your own license scenario.
SynapseIntegrationRuntimeSsisCatalogPricingTier	The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/.
SynapseIntegrationRuntimeState	The state of integration runtime.
SynapseIntegrationRuntimeUpdateResult	The result of the last integration runtime node update.
SynapseIotHubDataFormat	The data format of the message. Optionally the data format can be added to each message.
SynapseLanguageExtensionName	Language extension that can run within KQL query.
SynapseManagedIntegrationRuntimeNodeStatus	The managed integration runtime node status.
SynapsePrincipalAssignmentType	The type of resource, Microsoft.Synapse/workspaces/kustoPools/principalAssignments.
SynapsePrincipalsModificationKind	The principals modification kind of the database.
SynapsePrincipalType	Principal type.
SynapseProvisioningState	Resource provisioning state.
SynapseReplicationState	The replication state for the replication link.
SynapseSelfHostedIntegrationRuntimeNodeStatus	Status of the integration runtime node.
SynapseServerKeyType	The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.
SynapseSkuName	SKU name.
SynapseSparkConfigurationType	The type of the spark config properties file.
SynapseTransparentDataEncryptionName	The SynapseTransparentDataEncryptionName.
SynapseVulnerabilityAssessmentName	The SynapseVulnerabilityAssessmentName.
SynapseVulnerabilityAssessmentScanState	The scan status.
SynapseVulnerabilityAssessmentScanTriggerType	The scan trigger type.
WorkspacePublicNetworkAccess	Enable or Disable public network access to workspace.

Enums

KustoPoolDatabaseType	The type of resource, for instance Microsoft.Synapse/workspaces/kustoPools/databases.
SynapseBlobAuditingPolicyState	Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.
SynapseDataMaskingFunction	The masking function that is used for the data masking rule.
SynapseDataMaskingRuleState	The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.
SynapseDataMaskingState	The state of the data masking policy.
SynapseDesiredState	Desired state.
SynapseGeoBackupPolicyState	The state of the geo backup policy.
SynapseGrantSqlControlToManagedIdentityState	Actual state.
SynapseRecommendedSensitivityLabelUpdateKind	The SynapseRecommendedSensitivityLabelUpdateKind.
SynapseReplicationRole	The role of the Sql pool in the replication link.
SynapseRestorePointType	The type of restore point.
SynapseSecurityAlertPolicyState	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific Sql pool.
SynapseSensitivityLabelRank	The SynapseSensitivityLabelRank.
SynapseSensitivityLabelSource	The SynapseSensitivityLabelSource.
SynapseSensitivityLabelUpdateKind	The SynapseSensitivityLabelUpdateKind.
SynapseTransparentDataEncryptionStatus	The status of the database transparent data encryption.
SynapseVulnerabilityAssessmentPolicyBaselineName	The SynapseVulnerabilityAssessmentPolicyBaselineName.