Package-level declarations

Types

Link copied to clipboard
data class AutoPausePropertiesResponse(val delayInMinutes: Int? = null, val enabled: Boolean? = null)

Auto-pausing properties of a Big Data pool powered by Apache Spark

Link copied to clipboard
data class AutoScalePropertiesResponse(val enabled: Boolean? = null, val maxNodeCount: Int? = null, val minNodeCount: Int? = null)

Auto-scaling properties of a Big Data pool powered by Apache Spark

Link copied to clipboard
data class AzureSkuResponse(val capacity: Int? = null, val name: String, val tier: String)

Azure SKU definition.

Link copied to clipboard
data class CmdkeySetupResponse(val password: SecureStringResponse, val targetName: Any, val type: String, val userName: Any)

The custom setup of running cmdkey commands.

Link copied to clipboard
data class ComponentSetupResponse(val componentName: String, val licenseKey: SecureStringResponse? = null, val type: String)

The custom setup of installing 3rd party components.

Link copied to clipboard
data class CustomerManagedKeyDetailsResponse(val key: WorkspaceKeyDetailsResponse? = null, val status: String)

Details of the customer managed key associated with the workspace

Link copied to clipboard
data class DatabaseStatisticsResponse(val size: Double? = null)

A class that contains database statistics information.

Link copied to clipboard
data class DataLakeStorageAccountDetailsResponse(val accountUrl: String? = null, val filesystem: String? = null)

Details of the data lake storage account associated with the workspace

Link copied to clipboard
data class DynamicExecutorAllocationResponse(val enabled: Boolean? = null)

Dynamic Executor Allocation Properties

Link copied to clipboard
data class EncryptionDetailsResponse(val cmk: CustomerManagedKeyDetailsResponse? = null, val doubleEncryptionEnabled: Boolean)

Details of the encryption associated with the workspace

Link copied to clipboard
data class EntityReferenceResponse(val referenceName: String? = null, val type: String? = null)

The entity reference.

Link copied to clipboard
data class EnvironmentVariableSetupResponse(val type: String, val variableName: String, val variableValue: String)

The custom setup of setting environment variable.

Link copied to clipboard
data class FollowerDatabaseDefinitionResponse(val attachedDatabaseConfigurationName: String, val databaseName: String, val kustoPoolResourceId: String)

A class representing follower database request.

Link copied to clipboard
data class GetBigDataPoolResult(val autoPause: AutoPausePropertiesResponse? = null, val autoScale: AutoScalePropertiesResponse? = null, val cacheSize: Int? = null, val creationDate: String? = null, val customLibraries: List<LibraryInfoResponse>? = null, val defaultSparkLogFolder: String? = null, val dynamicExecutorAllocation: DynamicExecutorAllocationResponse? = null, val id: String, val isComputeIsolationEnabled: Boolean? = null, val lastSucceededTimestamp: String, val libraryRequirements: LibraryRequirementsResponse? = null, val location: String, val name: String, val nodeCount: Int? = null, val nodeSize: String? = null, val nodeSizeFamily: String? = null, val provisioningState: String? = null, val sessionLevelPackagesEnabled: Boolean? = null, val sparkConfigProperties: LibraryRequirementsResponse? = null, val sparkEventsFolder: String? = null, val sparkVersion: String? = null, val tags: Map<String, String>? = null, val type: String)

A Big Data pool

Link copied to clipboard
data class GetDatabasePrincipalAssignmentResult(val id: String, val name: String, val principalId: String, val principalName: String, val principalType: String, val provisioningState: String, val role: String, val systemData: SystemDataResponse, val tenantId: String? = null, val tenantName: String, val type: String)

Class representing a database principal assignment.

Link copied to clipboard
data class GetEventGridDataConnectionResult(val blobStorageEventType: String? = null, val consumerGroup: String, val dataFormat: String? = null, val eventHubResourceId: String, val id: String, val ignoreFirstRecord: Boolean? = null, val kind: String, val location: String? = null, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val storageAccountResourceId: String, val systemData: SystemDataResponse, val tableName: String? = null, val type: String)

Class representing an Event Grid data connection.

Link copied to clipboard
data class GetEventHubDataConnectionResult(val compression: String? = null, val consumerGroup: String, val dataFormat: String? = null, val eventHubResourceId: String, val eventSystemProperties: List<String>? = null, val id: String, val kind: String, val location: String? = null, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tableName: String? = null, val type: String)

Class representing an event hub data connection.

data class GetIntegrationRuntimeConnectionInfoResult(val hostServiceUri: String, val identityCertThumbprint: String, val isIdentityCertExprired: Boolean, val publicKey: String, val serviceToken: String, val version: String)

Connection information for encrypting the on-premises data source credentials.

data class GetIntegrationRuntimeObjectMetadatumResult(val nextLink: String? = null, val value: List<Any>? = null)

A list of SSIS object metadata.

Link copied to clipboard
data class GetIntegrationRuntimeResult(val etag: String, val id: String, val name: String, val properties: Either<ManagedIntegrationRuntimeResponse, SelfHostedIntegrationRuntimeResponse>, val type: String)

Integration runtime resource type.

Link copied to clipboard

Integration runtime status response.

Link copied to clipboard
data class GetIotHubDataConnectionResult(val consumerGroup: String, val dataFormat: String? = null, val eventSystemProperties: List<String>? = null, val id: String, val iotHubResourceId: String, val kind: String, val location: String? = null, val mappingRuleName: String? = null, val name: String, val provisioningState: String, val sharedAccessPolicyName: String, val systemData: SystemDataResponse, val tableName: String? = null, val type: String)

Class representing an iot hub data connection.

Link copied to clipboard
data class GetIpFirewallRuleResult(val endIpAddress: String? = null, val id: String, val name: String, val provisioningState: String, val startIpAddress: String? = null, val type: String)

IP firewall rule

Link copied to clipboard
data class GetKeyResult(val id: String, val isActiveCMK: Boolean? = null, val keyVaultUrl: String? = null, val name: String, val type: String)

A workspace key

data class GetKustoPoolAttachedDatabaseConfigurationResult(val attachedDatabaseNames: List<String>, val databaseName: String, val defaultPrincipalsModificationKind: String, val id: String, val kustoPoolResourceId: String, val location: String? = null, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tableLevelSharingProperties: TableLevelSharingPropertiesResponse? = null, val type: String)

Class representing an attached database configuration.

Link copied to clipboard
data class GetKustoPoolPrincipalAssignmentResult(val id: String, val name: String, val principalId: String, val principalName: String, val principalType: String, val provisioningState: String, val role: String, val systemData: SystemDataResponse, val tenantId: String? = null, val tenantName: String, val type: String)

Class representing a cluster principal assignment.

Link copied to clipboard
data class GetkustoPoolResult(val dataIngestionUri: String, val engineType: String? = null, val etag: String, val id: String, val location: String, val name: String, val provisioningState: String, val sku: AzureSkuResponse, val state: String, val stateReason: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val uri: String, val workspaceUid: String? = null)

Class representing a Kusto kusto pool.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetPrivateLinkHubResult(val id: String, val location: String, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionForPrivateLinkHubBasicResponse>, val provisioningState: String? = null, val tags: Map<String, String>? = null, val type: String)

A privateLinkHub

Link copied to clipboard
data class GetReadWriteDatabaseResult(val hotCachePeriod: String? = null, val id: String, val isFollowed: Boolean, val kind: String, val location: String? = null, val name: String, val provisioningState: String, val softDeletePeriod: String? = null, val statistics: DatabaseStatisticsResponse, val systemData: SystemDataResponse, val type: String)

Class representing a read write database.

Link copied to clipboard
data class GetSqlPoolResult(val collation: String? = null, val createMode: String? = null, val creationDate: String? = null, val id: String, val location: String, val maxSizeBytes: Double? = null, val name: String, val provisioningState: String? = null, val recoverableDatabaseId: String? = null, val restorePointInTime: String? = null, val sku: SkuResponse? = null, val sourceDatabaseId: String? = null, val status: String? = null, val storageAccountType: String? = null, val tags: Map<String, String>? = null, val type: String)

A SQL Analytics pool

Link copied to clipboard
data class GetSqlPoolSensitivityLabelResult(val columnName: String, val id: String, val informationType: String? = null, val informationTypeId: String? = null, val isDisabled: Boolean, val labelId: String? = null, val labelName: String? = null, val managedBy: String, val name: String, val rank: String? = null, val schemaName: String, val tableName: String, val type: String)

A sensitivity label.

data class GetSqlPoolTransparentDataEncryptionResult(val id: String, val location: String, val name: String, val status: String? = null, val type: String)

Represents a Sql pool transparent data encryption configuration.

Link copied to clipboard
data class GetSqlPoolVulnerabilityAssessmentResult(val id: String, val name: String, val recurringScans: VulnerabilityAssessmentRecurringScansPropertiesResponse? = null, val type: String)

A Sql pool vulnerability assessment.

A Sql pool vulnerability assessment rule baseline.

Link copied to clipboard
data class GetSqlPoolWorkloadClassifierResult(val context: String? = null, val endTime: String? = null, val id: String, val importance: String? = null, val label: String? = null, val memberName: String, val name: String, val startTime: String? = null, val type: String)

Workload classifier operations for a data warehouse

Link copied to clipboard
data class GetSqlPoolWorkloadGroupResult(val id: String, val importance: String? = null, val maxResourcePercent: Int, val maxResourcePercentPerRequest: Double? = null, val minResourcePercent: Int, val minResourcePercentPerRequest: Double, val name: String, val queryExecutionTimeout: Int? = null, val type: String)

Workload group operations for a sql pool

Link copied to clipboard
data class GetWorkspaceAadAdminResult(val administratorType: String? = null, val id: String, val login: String? = null, val name: String, val sid: String? = null, val tenantId: String? = null, val type: String)

Workspace active directory administrator

data class GetWorkspaceManagedSqlServerVulnerabilityAssessmentResult(val id: String, val name: String, val recurringScans: VulnerabilityAssessmentRecurringScansPropertiesResponse? = null, val storageContainerPath: String, val type: String)

A server vulnerability assessment.

Link copied to clipboard
data class GetWorkspaceResult(val adlaResourceId: String, val connectivityEndpoints: Map<String, String>? = null, val defaultDataLakeStorage: DataLakeStorageAccountDetailsResponse? = null, val encryption: EncryptionDetailsResponse? = null, val extraProperties: Map<String, Any>, val id: String, val identity: ManagedIdentityResponse? = null, val location: String, val managedResourceGroupName: String? = null, val managedVirtualNetwork: String? = null, val managedVirtualNetworkSettings: ManagedVirtualNetworkSettingsResponse? = null, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val provisioningState: String, val publicNetworkAccess: String? = null, val purviewConfiguration: PurviewConfigurationResponse? = null, val sqlAdministratorLogin: String? = null, val sqlAdministratorLoginPassword: String? = null, val tags: Map<String, String>? = null, val type: String, val virtualNetworkProfile: VirtualNetworkProfileResponse? = null, val workspaceRepositoryConfiguration: WorkspaceRepositoryConfigurationResponse? = null, val workspaceUID: String)

A workspace

Link copied to clipboard
data class GetWorkspaceSqlAadAdminResult(val administratorType: String? = null, val id: String, val login: String? = null, val name: String, val sid: String? = null, val tenantId: String? = null, val type: String)

Workspace active directory administrator

data class IntegrationRuntimeComputePropertiesResponse(val dataFlowProperties: IntegrationRuntimeDataFlowPropertiesResponse? = null, val location: String? = null, val maxParallelExecutionsPerNode: Int? = null, val nodeSize: String? = null, val numberOfNodes: Int? = null, val vNetProperties: IntegrationRuntimeVNetPropertiesResponse? = null)

The compute resource properties for managed integration runtime.

data class IntegrationRuntimeCustomSetupScriptPropertiesResponse(val blobContainerUri: String? = null, val sasToken: SecureStringResponse? = null)

Custom setup script properties for a managed dedicated integration runtime.

data class IntegrationRuntimeDataFlowPropertiesResponse(val computeType: String? = null, val coreCount: Int? = null, val timeToLive: Int? = null)

Data flow properties for managed integration runtime.

data class IntegrationRuntimeDataProxyPropertiesResponse(val connectVia: EntityReferenceResponse? = null, val path: String? = null, val stagingLinkedService: EntityReferenceResponse? = null)

Data proxy properties for a managed dedicated integration runtime.

data class IntegrationRuntimeSsisCatalogInfoResponse(val catalogAdminPassword: SecureStringResponse? = null, val catalogAdminUserName: String? = null, val catalogPricingTier: String? = null, val catalogServerEndpoint: String? = null)

Catalog information for managed dedicated integration runtime.

Link copied to clipboard
data class IntegrationRuntimeSsisPropertiesResponse(val catalogInfo: IntegrationRuntimeSsisCatalogInfoResponse? = null, val customSetupScriptProperties: IntegrationRuntimeCustomSetupScriptPropertiesResponse? = null, val dataProxyProperties: IntegrationRuntimeDataProxyPropertiesResponse? = null, val edition: String? = null, val expressCustomSetupProperties: List<Any>? = null, val licenseType: String? = null)

SSIS properties for managed integration runtime.

Link copied to clipboard
data class IntegrationRuntimeVNetPropertiesResponse(val publicIPs: List<String>? = null, val subnet: String? = null, val subnetId: String? = null, val vNetId: String? = null)

VNet properties for managed integration runtime.

Link copied to clipboard
data class LanguageExtensionResponse(val languageExtensionName: String? = null)

The language extension object.

Link copied to clipboard
data class LibraryInfoResponse(val containerName: String? = null, val creatorId: String, val name: String? = null, val path: String? = null, val provisioningStatus: String, val type: String? = null, val uploadedTimestamp: String)

Library/package information of a Big Data pool powered by Apache Spark

Link copied to clipboard
data class LibraryRequirementsResponse(val content: String? = null, val filename: String? = null, val time: String)

Library requirements for a Big Data pool powered by Apache Spark

The key authorization type integration runtime.

data class LinkedIntegrationRuntimeRbacAuthorizationResponse(val authorizationType: String, val resourceId: String)

The role based access control (RBAC) authorization type integration runtime.

Link copied to clipboard
data class LinkedIntegrationRuntimeResponse(val createTime: String, val dataFactoryLocation: String, val dataFactoryName: String, val name: String, val subscriptionId: String)

The linked integration runtime information.

Link copied to clipboard
data class ListIntegrationRuntimeAuthKeyResult(val authKey1: String? = null, val authKey2: String? = null)

The integration runtime authentication keys.

Link copied to clipboard

The list Kusto database principals operation response.

Link copied to clipboard

The list of language extension objects.

Link copied to clipboard
data class ManagedIdentityResponse(val principalId: String, val tenantId: String, val type: String? = null)

The workspace managed identity

Link copied to clipboard
data class ManagedIntegrationRuntimeErrorResponse(val code: String, val message: String, val parameters: List<String>, val time: String)

Error definition for managed integration runtime.

Link copied to clipboard
data class ManagedIntegrationRuntimeNodeResponse(val errors: List<ManagedIntegrationRuntimeErrorResponse>? = null, val nodeId: String, val status: String)

Properties of integration runtime node.

data class ManagedIntegrationRuntimeOperationResultResponse(val activityId: String, val errorCode: String, val parameters: List<String>, val result: String, val startTime: String, val type: String)

Properties of managed integration runtime operation result.

Link copied to clipboard
data class ManagedIntegrationRuntimeResponse(val computeProperties: IntegrationRuntimeComputePropertiesResponse? = null, val description: String? = null, val ssisProperties: IntegrationRuntimeSsisPropertiesResponse? = null, val state: String, val type: String)

Managed integration runtime, including managed elastic and managed dedicated integration runtimes.

Link copied to clipboard
data class ManagedIntegrationRuntimeStatusResponse(val createTime: String, val dataFactoryName: String, val lastOperation: ManagedIntegrationRuntimeOperationResultResponse, val nodes: List<ManagedIntegrationRuntimeNodeResponse>, val otherErrors: List<ManagedIntegrationRuntimeErrorResponse>, val state: String, val type: String)

Managed integration runtime status.

Link copied to clipboard
data class ManagedVirtualNetworkSettingsResponse(val allowedAadTenantIdsForLinking: List<String>? = null, val linkedAccessCheckOnTargetResource: Boolean? = null, val preventDataExfiltration: Boolean? = null)

Managed Virtual Network Settings

data class PrivateEndpointConnectionForPrivateLinkHubBasicResponse(val id: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String)

Private Endpoint Connection For Private Link Hub - Basic

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val id: String, val name: String, val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse? = null, val provisioningState: String, val type: String)

A private endpoint connection

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

Private endpoint details

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String, val description: String? = null, val status: String? = null)

Connection state details of the private endpoint

Link copied to clipboard
data class PurviewConfigurationResponse(val purviewResourceId: String? = null)

Purview Configuration

Link copied to clipboard
data class SecureStringResponse(val type: String, val value: String)

Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls.

Link copied to clipboard
data class SelfHostedIntegrationRuntimeNodeResponse(val capabilities: Map<String, String>, val concurrentJobsLimit: Int, val expiryTime: String, val hostServiceUri: String, val isActiveDispatcher: Boolean, val lastConnectTime: String, val lastEndUpdateTime: String, val lastStartTime: String, val lastStartUpdateTime: String, val lastStopTime: String, val lastUpdateResult: String, val machineName: String, val maxConcurrentJobs: Int, val nodeName: String, val registerTime: String, val status: String, val version: String, val versionStatus: String)

Properties of Self-hosted integration runtime node.

Link copied to clipboard

Self-hosted integration runtime.

data class SelfHostedIntegrationRuntimeStatusResponse(val autoUpdate: String, val autoUpdateETA: String, val capabilities: Map<String, String>, val createTime: String, val dataFactoryName: String, val internalChannelEncryption: String, val latestVersion: String, val links: List<LinkedIntegrationRuntimeResponse>? = null, val localTimeZoneOffset: String, val nodeCommunicationChannelEncryptionMode: String, val nodes: List<SelfHostedIntegrationRuntimeNodeResponse>? = null, val pushedVersion: String, val scheduledUpdateDate: String, val serviceUrls: List<String>, val state: String, val taskQueueId: String, val type: String, val updateDelayOffset: String, val version: String, val versionStatus: String)

Self-hosted integration runtime status.

Link copied to clipboard
data class SkuResponse(val capacity: Int? = null, val name: String? = null, val tier: String? = null)

SQL pool SKU

Properties for an Sql pool vulnerability assessment rule baseline's result.

Link copied to clipboard
data class SsisEnvironmentReferenceResponse(val environmentFolderName: String? = null, val environmentName: String? = null, val id: Double? = null, val referenceType: String? = null)

Ssis environment reference.

Link copied to clipboard
data class SsisEnvironmentResponse(val description: String? = null, val folderId: Double? = null, val id: Double? = null, val name: String? = null, val type: String, val variables: List<SsisVariableResponse>? = null)

Ssis environment.

Link copied to clipboard
data class SsisFolderResponse(val description: String? = null, val id: Double? = null, val name: String? = null, val type: String)

Ssis folder.

Link copied to clipboard
data class SsisPackageResponse(val description: String? = null, val folderId: Double? = null, val id: Double? = null, val name: String? = null, val parameters: List<SsisParameterResponse>? = null, val projectId: Double? = null, val projectVersion: Double? = null, val type: String)

Ssis Package.

Link copied to clipboard
data class SsisParameterResponse(val dataType: String? = null, val defaultValue: String? = null, val description: String? = null, val designDefaultValue: String? = null, val id: Double? = null, val name: String? = null, val required: Boolean? = null, val sensitive: Boolean? = null, val sensitiveDefaultValue: String? = null, val valueSet: Boolean? = null, val valueType: String? = null, val variable: String? = null)

Ssis parameter.

Link copied to clipboard
data class SsisProjectResponse(val description: String? = null, val environmentRefs: List<SsisEnvironmentReferenceResponse>? = null, val folderId: Double? = null, val id: Double? = null, val name: String? = null, val parameters: List<SsisParameterResponse>? = null, val type: String, val version: Double? = null)

Ssis project.

Link copied to clipboard
data class SsisVariableResponse(val dataType: String? = null, val description: String? = null, val id: Double? = null, val name: String? = null, val sensitive: Boolean? = null, val sensitiveValue: String? = null, val value: String? = null)

Ssis variable.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TableLevelSharingPropertiesResponse(val externalTablesToExclude: List<String>? = null, val externalTablesToInclude: List<String>? = null, val materializedViewsToExclude: List<String>? = null, val materializedViewsToInclude: List<String>? = null, val tablesToExclude: List<String>? = null, val tablesToInclude: List<String>? = null)

Tables that will be included and excluded in the follower database

Link copied to clipboard
data class VirtualNetworkProfileResponse(val computeSubnetId: String? = null)

Virtual Network Profile

data class VulnerabilityAssessmentRecurringScansPropertiesResponse(val emailSubscriptionAdmins: Boolean? = null, val emails: List<String>? = null, val isEnabled: Boolean? = null)

Properties of a Vulnerability Assessment recurring scans.

Link copied to clipboard
data class WorkspaceKeyDetailsResponse(val keyVaultUrl: String? = null, val name: String? = null)

Details of the customer managed key associated with the workspace

Link copied to clipboard
data class WorkspaceRepositoryConfigurationResponse(val accountName: String? = null, val collaborationBranch: String? = null, val hostName: String? = null, val lastCommitId: String? = null, val projectName: String? = null, val repositoryName: String? = null, val rootFolder: String? = null, val tenantId: String? = null, val type: String? = null)

Git integration settings