synapse.azure.com/v1api20210601

Package v1api20210601 contains API Schema definitions for the synapse v1api20210601 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-06-01"

AutoPauseProperties

(Appears on:Workspaces_BigDataPool_Spec)

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

Field	Description
`delayInMinutes` int	DelayInMinutes: Number of minutes of idle time before the Big Data pool is automatically paused.
`enabled` bool	Enabled: Whether auto-pausing is enabled for the Big Data pool.

AutoPauseProperties_ARM

(Appears on:BigDataPoolResourceProperties_ARM)

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

Field	Description
`delayInMinutes` int	DelayInMinutes: Number of minutes of idle time before the Big Data pool is automatically paused.
`enabled` bool	Enabled: Whether auto-pausing is enabled for the Big Data pool.

AutoPauseProperties_STATUS

(Appears on:Workspaces_BigDataPool_STATUS)

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

Field	Description
`delayInMinutes` int	DelayInMinutes: Number of minutes of idle time before the Big Data pool is automatically paused.
`enabled` bool	Enabled: Whether auto-pausing is enabled for the Big Data pool.

AutoPauseProperties_STATUS_ARM

(Appears on:BigDataPoolResourceProperties_STATUS_ARM)

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

Field	Description
`delayInMinutes` int	DelayInMinutes: Number of minutes of idle time before the Big Data pool is automatically paused.
`enabled` bool	Enabled: Whether auto-pausing is enabled for the Big Data pool.

AutoScaleProperties

(Appears on:Workspaces_BigDataPool_Spec)

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

Field	Description
`enabled` bool	Enabled: Whether automatic scaling is enabled for the Big Data pool.
`maxNodeCount` int	MaxNodeCount: The maximum number of nodes the Big Data pool can support.
`minNodeCount` int	MinNodeCount: The minimum number of nodes the Big Data pool can support.

AutoScaleProperties_ARM

(Appears on:BigDataPoolResourceProperties_ARM)

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

Field	Description
`enabled` bool	Enabled: Whether automatic scaling is enabled for the Big Data pool.
`maxNodeCount` int	MaxNodeCount: The maximum number of nodes the Big Data pool can support.
`minNodeCount` int	MinNodeCount: The minimum number of nodes the Big Data pool can support.

AutoScaleProperties_STATUS

(Appears on:Workspaces_BigDataPool_STATUS)

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

Field	Description
`enabled` bool	Enabled: Whether automatic scaling is enabled for the Big Data pool.
`maxNodeCount` int	MaxNodeCount: The maximum number of nodes the Big Data pool can support.
`minNodeCount` int	MinNodeCount: The minimum number of nodes the Big Data pool can support.

AutoScaleProperties_STATUS_ARM

(Appears on:BigDataPoolResourceProperties_STATUS_ARM)

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

Field	Description
`enabled` bool	Enabled: Whether automatic scaling is enabled for the Big Data pool.
`maxNodeCount` int	MaxNodeCount: The maximum number of nodes the Big Data pool can support.
`minNodeCount` int	MinNodeCount: The minimum number of nodes the Big Data pool can support.

BigDataPoolResourceProperties_ARM

(Appears on:Workspaces_BigDataPool_Spec_ARM)

Properties of a Big Data pool powered by Apache Spark

Field	Description
`autoPause` AutoPauseProperties_ARM	AutoPause: Auto-pausing properties
`autoScale` AutoScaleProperties_ARM	AutoScale: Auto-scaling properties
`cacheSize` int	CacheSize: The cache size
`customLibraries` []LibraryInfo_ARM	CustomLibraries: List of custom libraries/packages associated with the spark pool.
`defaultSparkLogFolder` string	DefaultSparkLogFolder: The default folder where Spark logs will be written.
`dynamicExecutorAllocation` DynamicExecutorAllocation_ARM	DynamicExecutorAllocation: Dynamic Executor Allocation
`isAutotuneEnabled` bool	IsAutotuneEnabled: Whether autotune is required or not.
`isComputeIsolationEnabled` bool	IsComputeIsolationEnabled: Whether compute isolation is required or not.
`libraryRequirements` LibraryRequirements_ARM	LibraryRequirements: Library version requirements
`nodeCount` int	NodeCount: The number of nodes in the Big Data pool.
`nodeSize` BigDataPoolResourceProperties_NodeSize	NodeSize: The level of compute power that each node in the Big Data pool has.
`nodeSizeFamily` BigDataPoolResourceProperties_NodeSizeFamily	NodeSizeFamily: The kind of nodes that the Big Data pool provides.
`provisioningState` string	ProvisioningState: The state of the Big Data pool.
`sessionLevelPackagesEnabled` bool	SessionLevelPackagesEnabled: Whether session level packages enabled.
`sparkConfigProperties` SparkConfigProperties_ARM	SparkConfigProperties: Spark configuration file to specify additional properties
`sparkEventsFolder` string	SparkEventsFolder: The Spark events folder
`sparkVersion` string	SparkVersion: The Apache Spark version.

BigDataPoolResourceProperties_NodeSize (`string` alias)

(Appears on:BigDataPoolResourceProperties_ARM, Workspaces_BigDataPool_Spec)

Value	Description
"Large"
"Medium"
"None"
"Small"
"XLarge"
"XXLarge"
"XXXLarge"

BigDataPoolResourceProperties_NodeSizeFamily (`string` alias)

(Appears on:BigDataPoolResourceProperties_ARM, Workspaces_BigDataPool_Spec)

Value	Description
"HardwareAcceleratedFPGA"
"HardwareAcceleratedGPU"
"MemoryOptimized"
"None"

BigDataPoolResourceProperties_NodeSizeFamily_STATUS (`string` alias)

(Appears on:BigDataPoolResourceProperties_STATUS_ARM, Workspaces_BigDataPool_STATUS)

Value	Description
"HardwareAcceleratedFPGA"
"HardwareAcceleratedGPU"
"MemoryOptimized"
"None"

BigDataPoolResourceProperties_NodeSize_STATUS (`string` alias)

(Appears on:BigDataPoolResourceProperties_STATUS_ARM, Workspaces_BigDataPool_STATUS)

Value	Description
"Large"
"Medium"
"None"
"Small"
"XLarge"
"XXLarge"
"XXXLarge"

BigDataPoolResourceProperties_STATUS_ARM

(Appears on:Workspaces_BigDataPool_STATUS_ARM)

Properties of a Big Data pool powered by Apache Spark

Field	Description
`autoPause` AutoPauseProperties_STATUS_ARM	AutoPause: Auto-pausing properties
`autoScale` AutoScaleProperties_STATUS_ARM	AutoScale: Auto-scaling properties
`cacheSize` int	CacheSize: The cache size
`creationDate` string	CreationDate: The time when the Big Data pool was created.
`customLibraries` []LibraryInfo_STATUS_ARM	CustomLibraries: List of custom libraries/packages associated with the spark pool.
`defaultSparkLogFolder` string	DefaultSparkLogFolder: The default folder where Spark logs will be written.
`dynamicExecutorAllocation` DynamicExecutorAllocation_STATUS_ARM	DynamicExecutorAllocation: Dynamic Executor Allocation
`isAutotuneEnabled` bool	IsAutotuneEnabled: Whether autotune is required or not.
`isComputeIsolationEnabled` bool	IsComputeIsolationEnabled: Whether compute isolation is required or not.
`lastSucceededTimestamp` string	LastSucceededTimestamp: The time when the Big Data pool was updated successfully.
`libraryRequirements` LibraryRequirements_STATUS_ARM	LibraryRequirements: Library version requirements
`nodeCount` int	NodeCount: The number of nodes in the Big Data pool.
`nodeSize` BigDataPoolResourceProperties_NodeSize_STATUS	NodeSize: The level of compute power that each node in the Big Data pool has.
`nodeSizeFamily` BigDataPoolResourceProperties_NodeSizeFamily_STATUS	NodeSizeFamily: The kind of nodes that the Big Data pool provides.
`provisioningState` string	ProvisioningState: The state of the Big Data pool.
`sessionLevelPackagesEnabled` bool	SessionLevelPackagesEnabled: Whether session level packages enabled.
`sparkConfigProperties` SparkConfigProperties_STATUS_ARM	SparkConfigProperties: Spark configuration file to specify additional properties
`sparkEventsFolder` string	SparkEventsFolder: The Spark events folder
`sparkVersion` string	SparkVersion: The Apache Spark version.

CspWorkspaceAdminProperties

(Appears on:Workspace_Spec)

Initial workspace AAD admin properties for a CSP subscription

Field	Description
`initialWorkspaceAdminObjectId` string	InitialWorkspaceAdminObjectId: AAD object ID of initial workspace admin

CspWorkspaceAdminProperties_ARM

(Appears on:WorkspaceProperties_ARM)

Initial workspace AAD admin properties for a CSP subscription

Field	Description
`initialWorkspaceAdminObjectId` string	InitialWorkspaceAdminObjectId: AAD object ID of initial workspace admin

CspWorkspaceAdminProperties_STATUS

(Appears on:Workspace_STATUS)

Initial workspace AAD admin properties for a CSP subscription

Field	Description
`initialWorkspaceAdminObjectId` string	InitialWorkspaceAdminObjectId: AAD object ID of initial workspace admin

CspWorkspaceAdminProperties_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Initial workspace AAD admin properties for a CSP subscription

Field	Description
`initialWorkspaceAdminObjectId` string	InitialWorkspaceAdminObjectId: AAD object ID of initial workspace admin

CustomerManagedKeyDetails

(Appears on:EncryptionDetails)

Details of the customer managed key associated with the workspace

Field	Description
`kekIdentity` KekIdentityProperties	KekIdentity: Key encryption key
`key` WorkspaceKeyDetails	Key: The key object of the workspace

CustomerManagedKeyDetails_ARM

(Appears on:EncryptionDetails_ARM)

Details of the customer managed key associated with the workspace

Field	Description
`kekIdentity` KekIdentityProperties_ARM	KekIdentity: Key encryption key
`key` WorkspaceKeyDetails_ARM	Key: The key object of the workspace

CustomerManagedKeyDetails_STATUS

(Appears on:EncryptionDetails_STATUS)

Details of the customer managed key associated with the workspace

Field	Description
`kekIdentity` KekIdentityProperties_STATUS	KekIdentity: Key encryption key
`key` WorkspaceKeyDetails_STATUS	Key: The key object of the workspace
`status` string	Status: The customer managed key status on the workspace

CustomerManagedKeyDetails_STATUS_ARM

(Appears on:EncryptionDetails_STATUS_ARM)

Details of the customer managed key associated with the workspace

Field	Description
`kekIdentity` KekIdentityProperties_STATUS_ARM	KekIdentity: Key encryption key
`key` WorkspaceKeyDetails_STATUS_ARM	Key: The key object of the workspace
`status` string	Status: The customer managed key status on the workspace

DataLakeStorageAccountDetails

(Appears on:Workspace_Spec)

Details of the data lake storage account associated with the workspace

Field	Description
`accountUrl` string	AccountUrl: Account URL
`accountUrlFromConfig` genruntime.ConfigMapReference	AccountUrlFromConfig: Account URL
`createManagedPrivateEndpoint` bool	CreateManagedPrivateEndpoint: Create managed private endpoint to this storage account or not
`filesystem` string	Filesystem: Filesystem name
`resourceReference` genruntime.ResourceReference	ResourceReference: ARM resource Id of this storage account

DataLakeStorageAccountDetails_ARM

(Appears on:WorkspaceProperties_ARM)

Details of the data lake storage account associated with the workspace

Field	Description
`accountUrl` string	AccountUrl: Account URL
`createManagedPrivateEndpoint` bool	CreateManagedPrivateEndpoint: Create managed private endpoint to this storage account or not
`filesystem` string	Filesystem: Filesystem name
`resourceId` string

DataLakeStorageAccountDetails_STATUS

(Appears on:Workspace_STATUS)

Details of the data lake storage account associated with the workspace

Field	Description
`accountUrl` string	AccountUrl: Account URL
`createManagedPrivateEndpoint` bool	CreateManagedPrivateEndpoint: Create managed private endpoint to this storage account or not
`filesystem` string	Filesystem: Filesystem name
`resourceId` string	ResourceId: ARM resource Id of this storage account

DataLakeStorageAccountDetails_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Details of the data lake storage account associated with the workspace

Field	Description
`accountUrl` string	AccountUrl: Account URL
`createManagedPrivateEndpoint` bool	CreateManagedPrivateEndpoint: Create managed private endpoint to this storage account or not
`filesystem` string	Filesystem: Filesystem name
`resourceId` string	ResourceId: ARM resource Id of this storage account

DynamicExecutorAllocation

(Appears on:Workspaces_BigDataPool_Spec)

Dynamic Executor Allocation Properties

Field	Description
`enabled` bool	Enabled: Indicates whether Dynamic Executor Allocation is enabled or not.
`maxExecutors` int	MaxExecutors: The maximum number of executors alloted
`minExecutors` int	MinExecutors: The minimum number of executors alloted

DynamicExecutorAllocation_ARM

(Appears on:BigDataPoolResourceProperties_ARM)

Dynamic Executor Allocation Properties

Field	Description
`enabled` bool	Enabled: Indicates whether Dynamic Executor Allocation is enabled or not.
`maxExecutors` int	MaxExecutors: The maximum number of executors alloted
`minExecutors` int	MinExecutors: The minimum number of executors alloted

DynamicExecutorAllocation_STATUS

(Appears on:Workspaces_BigDataPool_STATUS)

Dynamic Executor Allocation Properties

Field	Description
`enabled` bool	Enabled: Indicates whether Dynamic Executor Allocation is enabled or not.
`maxExecutors` int	MaxExecutors: The maximum number of executors alloted
`minExecutors` int	MinExecutors: The minimum number of executors alloted

DynamicExecutorAllocation_STATUS_ARM

(Appears on:BigDataPoolResourceProperties_STATUS_ARM)

Dynamic Executor Allocation Properties

Field	Description
`enabled` bool	Enabled: Indicates whether Dynamic Executor Allocation is enabled or not.
`maxExecutors` int	MaxExecutors: The maximum number of executors alloted
`minExecutors` int	MinExecutors: The minimum number of executors alloted

EncryptionDetails

(Appears on:Workspace_Spec)

Details of the encryption associated with the workspace

Field	Description
`cmk` CustomerManagedKeyDetails	Cmk: Customer Managed Key Details

EncryptionDetails_ARM

(Appears on:WorkspaceProperties_ARM)

Details of the encryption associated with the workspace

Field	Description
`cmk` CustomerManagedKeyDetails_ARM	Cmk: Customer Managed Key Details

EncryptionDetails_STATUS

(Appears on:Workspace_STATUS)

Details of the encryption associated with the workspace

Field	Description
`cmk` CustomerManagedKeyDetails_STATUS	Cmk: Customer Managed Key Details
`doubleEncryptionEnabled` bool	DoubleEncryptionEnabled: Double Encryption enabled

EncryptionDetails_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Details of the encryption associated with the workspace

Field	Description
`cmk` CustomerManagedKeyDetails_STATUS_ARM	Cmk: Customer Managed Key Details
`doubleEncryptionEnabled` bool	DoubleEncryptionEnabled: Double Encryption enabled

KekIdentityProperties

(Appears on:CustomerManagedKeyDetails)

Key encryption key properties

Field	Description
`useSystemAssignedIdentity` Kubernetes v1.JSON	UseSystemAssignedIdentity: Boolean specifying whether to use system assigned identity or not
`userAssignedIdentityReference` genruntime.ResourceReference	UserAssignedIdentityReference: User assigned identity resource Id

KekIdentityProperties_ARM

(Appears on:CustomerManagedKeyDetails_ARM)

Key encryption key properties

Field	Description
`useSystemAssignedIdentity` Kubernetes v1.JSON	UseSystemAssignedIdentity: Boolean specifying whether to use system assigned identity or not
`userAssignedIdentity` string

KekIdentityProperties_STATUS

(Appears on:CustomerManagedKeyDetails_STATUS)

Key encryption key properties

Field	Description
`useSystemAssignedIdentity` Kubernetes v1.JSON	UseSystemAssignedIdentity: Boolean specifying whether to use system assigned identity or not
`userAssignedIdentity` string	UserAssignedIdentity: User assigned identity resource Id

KekIdentityProperties_STATUS_ARM

(Appears on:CustomerManagedKeyDetails_STATUS_ARM)

Key encryption key properties

Field	Description
`useSystemAssignedIdentity` Kubernetes v1.JSON	UseSystemAssignedIdentity: Boolean specifying whether to use system assigned identity or not
`userAssignedIdentity` string	UserAssignedIdentity: User assigned identity resource Id

LibraryInfo

(Appears on:Workspaces_BigDataPool_Spec)

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

Field	Description
`containerName` string	ContainerName: Storage blob container name.
`name` string	Name: Name of the library.
`path` string	Path: Storage blob path of library.
`type` string	Type: Type of the library.

LibraryInfo_ARM

(Appears on:BigDataPoolResourceProperties_ARM)

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

Field	Description
`containerName` string	ContainerName: Storage blob container name.
`name` string	Name: Name of the library.
`path` string	Path: Storage blob path of library.
`type` string	Type: Type of the library.

LibraryInfo_STATUS

(Appears on:Workspaces_BigDataPool_STATUS)

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

Field	Description
`containerName` string	ContainerName: Storage blob container name.
`creatorId` string	CreatorId: Creator Id of the library/package.
`name` string	Name: Name of the library.
`path` string	Path: Storage blob path of library.
`provisioningStatus` string	ProvisioningStatus: Provisioning status of the library/package.
`type` string	Type: Type of the library.
`uploadedTimestamp` string	UploadedTimestamp: The last update time of the library.

LibraryInfo_STATUS_ARM

(Appears on:BigDataPoolResourceProperties_STATUS_ARM)

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

Field	Description
`containerName` string	ContainerName: Storage blob container name.
`creatorId` string	CreatorId: Creator Id of the library/package.
`name` string	Name: Name of the library.
`path` string	Path: Storage blob path of library.
`provisioningStatus` string	ProvisioningStatus: Provisioning status of the library/package.
`type` string	Type: Type of the library.
`uploadedTimestamp` string	UploadedTimestamp: The last update time of the library.

LibraryRequirements

(Appears on:Workspaces_BigDataPool_Spec)

Library requirements for a Big Data pool powered by Apache Spark

Field	Description
`content` string	Content: The library requirements.
`filename` string	Filename: The filename of the library requirements file.

LibraryRequirements_ARM

(Appears on:BigDataPoolResourceProperties_ARM)

Library requirements for a Big Data pool powered by Apache Spark

Field	Description
`content` string	Content: The library requirements.
`filename` string	Filename: The filename of the library requirements file.

LibraryRequirements_STATUS

(Appears on:Workspaces_BigDataPool_STATUS)

Library requirements for a Big Data pool powered by Apache Spark

Field	Description
`content` string	Content: The library requirements.
`filename` string	Filename: The filename of the library requirements file.
`time` string	Time: The last update time of the library requirements file.

LibraryRequirements_STATUS_ARM

(Appears on:BigDataPoolResourceProperties_STATUS_ARM)

Library requirements for a Big Data pool powered by Apache Spark

Field	Description
`content` string	Content: The library requirements.
`filename` string	Filename: The filename of the library requirements file.
`time` string	Time: The last update time of the library requirements file.

ManagedIdentity

(Appears on:Workspace_Spec)

The workspace managed identity

Field	Description
`type` ManagedIdentity_Type	Type: The type of managed identity for the workspace
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: The user assigned managed identities.

ManagedIdentity_ARM

(Appears on:Workspace_Spec_ARM)

The workspace managed identity

Field	Description
`type` ManagedIdentity_Type	Type: The type of managed identity for the workspace
`userAssignedIdentities` map[string]./api/synapse/v1api20210601.UserAssignedIdentityDetails_ARM

ManagedIdentity_STATUS

(Appears on:Workspace_STATUS)

The workspace managed identity

Field	Description
`principalId` string	PrincipalId: The principal ID of the workspace managed identity
`tenantId` string	TenantId: The tenant ID of the workspace managed identity
`type` ManagedIdentity_Type_STATUS	Type: The type of managed identity for the workspace
`userAssignedIdentities` map[string]./api/synapse/v1api20210601.UserAssignedManagedIdentity_STATUS	UserAssignedIdentities: The user assigned managed identities.

ManagedIdentity_STATUS_ARM

(Appears on:Workspace_STATUS_ARM)

The workspace managed identity

Field	Description
`principalId` string	PrincipalId: The principal ID of the workspace managed identity
`tenantId` string	TenantId: The tenant ID of the workspace managed identity
`type` ManagedIdentity_Type_STATUS	Type: The type of managed identity for the workspace
`userAssignedIdentities` map[string]./api/synapse/v1api20210601.UserAssignedManagedIdentity_STATUS_ARM	UserAssignedIdentities: The user assigned managed identities.

ManagedIdentity_Type (`string` alias)

(Appears on:ManagedIdentity, ManagedIdentity_ARM)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned,UserAssigned"

ManagedIdentity_Type_STATUS (`string` alias)

(Appears on:ManagedIdentity_STATUS, ManagedIdentity_STATUS_ARM)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned,UserAssigned"

ManagedVirtualNetworkSettings

(Appears on:Workspace_Spec)

Managed Virtual Network Settings

Field	Description
`allowedAadTenantIdsForLinking` []string	AllowedAadTenantIdsForLinking: Allowed Aad Tenant Ids For Linking
`linkedAccessCheckOnTargetResource` bool	LinkedAccessCheckOnTargetResource: Linked Access Check On Target Resource
`preventDataExfiltration` bool	PreventDataExfiltration: Prevent Data Exfiltration

ManagedVirtualNetworkSettings_ARM

(Appears on:WorkspaceProperties_ARM)

Managed Virtual Network Settings

Field	Description
`allowedAadTenantIdsForLinking` []string	AllowedAadTenantIdsForLinking: Allowed Aad Tenant Ids For Linking
`linkedAccessCheckOnTargetResource` bool	LinkedAccessCheckOnTargetResource: Linked Access Check On Target Resource
`preventDataExfiltration` bool	PreventDataExfiltration: Prevent Data Exfiltration

ManagedVirtualNetworkSettings_STATUS

(Appears on:Workspace_STATUS)

Managed Virtual Network Settings

Field	Description
`allowedAadTenantIdsForLinking` []string	AllowedAadTenantIdsForLinking: Allowed Aad Tenant Ids For Linking
`linkedAccessCheckOnTargetResource` bool	LinkedAccessCheckOnTargetResource: Linked Access Check On Target Resource
`preventDataExfiltration` bool	PreventDataExfiltration: Prevent Data Exfiltration

ManagedVirtualNetworkSettings_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Managed Virtual Network Settings

Field	Description
`allowedAadTenantIdsForLinking` []string	AllowedAadTenantIdsForLinking: Allowed Aad Tenant Ids For Linking
`linkedAccessCheckOnTargetResource` bool	LinkedAccessCheckOnTargetResource: Linked Access Check On Target Resource
`preventDataExfiltration` bool	PreventDataExfiltration: Prevent Data Exfiltration

PrivateEndpointConnection_STATUS

(Appears on:Workspace_STATUS)

A private endpoint connection

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

PrivateEndpointConnection_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

A private endpoint connection

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

PurviewConfiguration

(Appears on:Workspace_Spec)

Purview Configuration

Field	Description
`purviewResourceReference` genruntime.ResourceReference	PurviewResourceReference: Purview Resource ID

PurviewConfiguration_ARM

(Appears on:WorkspaceProperties_ARM)

Purview Configuration

Field	Description
`purviewResourceId` string

PurviewConfiguration_STATUS

(Appears on:Workspace_STATUS)

Purview Configuration

Field	Description
`purviewResourceId` string	PurviewResourceId: Purview Resource ID

PurviewConfiguration_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Purview Configuration

Field	Description
`purviewResourceId` string	PurviewResourceId: Purview Resource ID

SparkConfigProperties

(Appears on:Workspaces_BigDataPool_Spec)

SparkConfig Properties for a Big Data pool powered by Apache Spark

Field	Description
`configurationType` SparkConfigProperties_ConfigurationType	ConfigurationType: The type of the spark config properties file.
`content` string	Content: The spark config properties.
`filename` string	Filename: The filename of the spark config properties file.

SparkConfigProperties_ARM

(Appears on:BigDataPoolResourceProperties_ARM)

SparkConfig Properties for a Big Data pool powered by Apache Spark

Field	Description
`configurationType` SparkConfigProperties_ConfigurationType	ConfigurationType: The type of the spark config properties file.
`content` string	Content: The spark config properties.
`filename` string	Filename: The filename of the spark config properties file.

SparkConfigProperties_ConfigurationType (`string` alias)

(Appears on:SparkConfigProperties, SparkConfigProperties_ARM)

Value	Description
"Artifact"
"File"

SparkConfigProperties_ConfigurationType_STATUS (`string` alias)

(Appears on:SparkConfigProperties_STATUS, SparkConfigProperties_STATUS_ARM)

Value	Description
"Artifact"
"File"

SparkConfigProperties_STATUS

(Appears on:Workspaces_BigDataPool_STATUS)

SparkConfig Properties for a Big Data pool powered by Apache Spark

Field	Description
`configurationType` SparkConfigProperties_ConfigurationType_STATUS	ConfigurationType: The type of the spark config properties file.
`content` string	Content: The spark config properties.
`filename` string	Filename: The filename of the spark config properties file.
`time` string	Time: The last update time of the spark config properties file.

SparkConfigProperties_STATUS_ARM

(Appears on:BigDataPoolResourceProperties_STATUS_ARM)

SparkConfig Properties for a Big Data pool powered by Apache Spark

Field	Description
`configurationType` SparkConfigProperties_ConfigurationType_STATUS	ConfigurationType: The type of the spark config properties file.
`content` string	Content: The spark config properties.
`filename` string	Filename: The filename of the spark config properties file.
`time` string	Time: The last update time of the spark config properties file.

UserAssignedIdentityDetails

(Appears on:ManagedIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserAssignedIdentityDetails_ARM

(Appears on:ManagedIdentity_ARM)

Information about the user assigned identity for the resource

UserAssignedManagedIdentity_STATUS

(Appears on:ManagedIdentity_STATUS)

User Assigned Managed Identity

Field	Description
`clientId` string	ClientId: The client ID.
`principalId` string	PrincipalId: The principal ID.

UserAssignedManagedIdentity_STATUS_ARM

(Appears on:ManagedIdentity_STATUS_ARM)

User Assigned Managed Identity

Field	Description
`clientId` string	ClientId: The client ID.
`principalId` string	PrincipalId: The principal ID.

VirtualNetworkProfile

(Appears on:Workspace_Spec)

Virtual Network Profile

Field	Description
`computeSubnetId` string	ComputeSubnetId: Subnet ID used for computes in workspace

VirtualNetworkProfile_ARM

(Appears on:WorkspaceProperties_ARM)

Virtual Network Profile

Field	Description
`computeSubnetId` string	ComputeSubnetId: Subnet ID used for computes in workspace

VirtualNetworkProfile_STATUS

(Appears on:Workspace_STATUS)

Virtual Network Profile

Field	Description
`computeSubnetId` string	ComputeSubnetId: Subnet ID used for computes in workspace

VirtualNetworkProfile_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Virtual Network Profile

Field	Description
`computeSubnetId` string	ComputeSubnetId: Subnet ID used for computes in workspace

Workspace

Generator information: - Generated from: /synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/workspace.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Workspace_Spec

`azureADOnlyAuthentication` bool	AzureADOnlyAuthentication: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`cspWorkspaceAdminProperties` CspWorkspaceAdminProperties	CspWorkspaceAdminProperties: Initial workspace AAD admin properties for a CSP subscription
`defaultDataLakeStorage` DataLakeStorageAccountDetails	DefaultDataLakeStorage: Workspace default data lake storage account details
`encryption` EncryptionDetails	Encryption: The encryption details of the workspace
`identity` ManagedIdentity	Identity: Identity of the workspace
`location` string	Location: The geo-location where the resource lives
`managedResourceGroupName` string	ManagedResourceGroupName: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-’, ‘_’, ‘(’, ‘)’ and’.‘. Note that the name cannot end with ‘.’
`managedVirtualNetwork` string	ManagedVirtualNetwork: Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
`managedVirtualNetworkSettings` ManagedVirtualNetworkSettings	ManagedVirtualNetworkSettings: Managed Virtual Network Settings
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess	PublicNetworkAccess: Enable or Disable public network access to workspace
`purviewConfiguration` PurviewConfiguration	PurviewConfiguration: Purview Configuration
`sqlAdministratorLogin` string	SqlAdministratorLogin: Login for workspace SQL active directory administrator
`sqlAdministratorLoginPassword` genruntime.SecretReference	SqlAdministratorLoginPassword: SQL administrator login password
`tags` map[string]string	Tags: Resource tags.
`trustedServiceBypassEnabled` bool	TrustedServiceBypassEnabled: Is trustedServiceBypassEnabled for the workspace
`virtualNetworkProfile` VirtualNetworkProfile	VirtualNetworkProfile: Virtual Network profile
`workspaceRepositoryConfiguration` WorkspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration: Git integration settings

status
Workspace_STATUS

WorkspaceKeyDetails

(Appears on:CustomerManagedKeyDetails)

Details of the customer managed key associated with the workspace

Field	Description
`keyVaultUrl` string	KeyVaultUrl: Workspace Key sub-resource key vault url
`name` string	Name: Workspace Key sub-resource name

WorkspaceKeyDetails_ARM

(Appears on:CustomerManagedKeyDetails_ARM)

Details of the customer managed key associated with the workspace

Field	Description
`keyVaultUrl` string	KeyVaultUrl: Workspace Key sub-resource key vault url
`name` string	Name: Workspace Key sub-resource name

WorkspaceKeyDetails_STATUS

(Appears on:CustomerManagedKeyDetails_STATUS)

Details of the customer managed key associated with the workspace

Field	Description
`keyVaultUrl` string	KeyVaultUrl: Workspace Key sub-resource key vault url
`name` string	Name: Workspace Key sub-resource name

WorkspaceKeyDetails_STATUS_ARM

(Appears on:CustomerManagedKeyDetails_STATUS_ARM)

Details of the customer managed key associated with the workspace

Field	Description
`keyVaultUrl` string	KeyVaultUrl: Workspace Key sub-resource key vault url
`name` string	Name: Workspace Key sub-resource name

WorkspaceProperties_ARM

(Appears on:Workspace_Spec_ARM)

Workspace properties

Field	Description
`azureADOnlyAuthentication` bool	AzureADOnlyAuthentication: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
`cspWorkspaceAdminProperties` CspWorkspaceAdminProperties_ARM	CspWorkspaceAdminProperties: Initial workspace AAD admin properties for a CSP subscription
`defaultDataLakeStorage` DataLakeStorageAccountDetails_ARM	DefaultDataLakeStorage: Workspace default data lake storage account details
`encryption` EncryptionDetails_ARM	Encryption: The encryption details of the workspace
`managedResourceGroupName` string	ManagedResourceGroupName: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-’, ‘_’, ‘(’, ‘)’ and’.‘. Note that the name cannot end with ‘.’
`managedVirtualNetwork` string	ManagedVirtualNetwork: Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
`managedVirtualNetworkSettings` ManagedVirtualNetworkSettings_ARM	ManagedVirtualNetworkSettings: Managed Virtual Network Settings
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess	PublicNetworkAccess: Enable or Disable public network access to workspace
`purviewConfiguration` PurviewConfiguration_ARM	PurviewConfiguration: Purview Configuration
`sqlAdministratorLogin` string	SqlAdministratorLogin: Login for workspace SQL active directory administrator
`sqlAdministratorLoginPassword` string	SqlAdministratorLoginPassword: SQL administrator login password
`trustedServiceBypassEnabled` bool	TrustedServiceBypassEnabled: Is trustedServiceBypassEnabled for the workspace
`virtualNetworkProfile` VirtualNetworkProfile_ARM	VirtualNetworkProfile: Virtual Network profile
`workspaceRepositoryConfiguration` WorkspaceRepositoryConfiguration_ARM	WorkspaceRepositoryConfiguration: Git integration settings

WorkspaceProperties_PublicNetworkAccess (`string` alias)

(Appears on:WorkspaceProperties_ARM, Workspace_Spec)

Value	Description
"Disabled"
"Enabled"

WorkspaceProperties_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:WorkspaceProperties_STATUS_ARM, Workspace_STATUS)

Value	Description
"Disabled"
"Enabled"

WorkspaceProperties_STATUS_ARM

(Appears on:Workspace_STATUS_ARM)

Workspace properties

Field	Description
`adlaResourceId` string	AdlaResourceId: The ADLA resource ID.
`azureADOnlyAuthentication` bool	AzureADOnlyAuthentication: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
`connectivityEndpoints` map[string]string	ConnectivityEndpoints: Connectivity endpoints
`cspWorkspaceAdminProperties` CspWorkspaceAdminProperties_STATUS_ARM	CspWorkspaceAdminProperties: Initial workspace AAD admin properties for a CSP subscription
`defaultDataLakeStorage` DataLakeStorageAccountDetails_STATUS_ARM	DefaultDataLakeStorage: Workspace default data lake storage account details
`encryption` EncryptionDetails_STATUS_ARM	Encryption: The encryption details of the workspace
`extraProperties` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	ExtraProperties: Workspace level configs and feature flags
`managedResourceGroupName` string	ManagedResourceGroupName: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-’, ‘_’, ‘(’, ‘)’ and’.‘. Note that the name cannot end with ‘.’
`managedVirtualNetwork` string	ManagedVirtualNetwork: Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
`managedVirtualNetworkSettings` ManagedVirtualNetworkSettings_STATUS_ARM	ManagedVirtualNetworkSettings: Managed Virtual Network Settings
`privateEndpointConnections` []PrivateEndpointConnection_STATUS_ARM	PrivateEndpointConnections: Private endpoint connections to the workspace
`provisioningState` string	ProvisioningState: Resource provisioning state
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Enable or Disable public network access to workspace
`purviewConfiguration` PurviewConfiguration_STATUS_ARM	PurviewConfiguration: Purview Configuration
`settings` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Settings: Workspace settings
`sqlAdministratorLogin` string	SqlAdministratorLogin: Login for workspace SQL active directory administrator
`trustedServiceBypassEnabled` bool	TrustedServiceBypassEnabled: Is trustedServiceBypassEnabled for the workspace
`virtualNetworkProfile` VirtualNetworkProfile_STATUS_ARM	VirtualNetworkProfile: Virtual Network profile
`workspaceRepositoryConfiguration` WorkspaceRepositoryConfiguration_STATUS_ARM	WorkspaceRepositoryConfiguration: Git integration settings
`workspaceUID` string	WorkspaceUID: The workspace unique identifier

WorkspaceRepositoryConfiguration

(Appears on:Workspace_Spec)

Git integration settings

Field	Description
`accountName` string	AccountName: Account name
`collaborationBranch` string	CollaborationBranch: Collaboration branch
`hostName` string	HostName: GitHub Enterprise host name. For example: `https://github.mydomain.com`
`lastCommitId` string	LastCommitId: The last commit ID
`projectName` string	ProjectName: VSTS project name
`repositoryName` string	RepositoryName: Repository name
`rootFolder` string	RootFolder: Root folder to use in the repository
`tenantId` string	TenantId: The VSTS tenant ID
`type` string	Type: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

WorkspaceRepositoryConfiguration_ARM

(Appears on:WorkspaceProperties_ARM)

Git integration settings

Field	Description
`accountName` string	AccountName: Account name
`collaborationBranch` string	CollaborationBranch: Collaboration branch
`hostName` string	HostName: GitHub Enterprise host name. For example: `https://github.mydomain.com`
`lastCommitId` string	LastCommitId: The last commit ID
`projectName` string	ProjectName: VSTS project name
`repositoryName` string	RepositoryName: Repository name
`rootFolder` string	RootFolder: Root folder to use in the repository
`tenantId` string	TenantId: The VSTS tenant ID
`type` string	Type: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

WorkspaceRepositoryConfiguration_STATUS

(Appears on:Workspace_STATUS)

Git integration settings

Field	Description
`accountName` string	AccountName: Account name
`collaborationBranch` string	CollaborationBranch: Collaboration branch
`hostName` string	HostName: GitHub Enterprise host name. For example: `https://github.mydomain.com`
`lastCommitId` string	LastCommitId: The last commit ID
`projectName` string	ProjectName: VSTS project name
`repositoryName` string	RepositoryName: Repository name
`rootFolder` string	RootFolder: Root folder to use in the repository
`tenantId` string	TenantId: The VSTS tenant ID
`type` string	Type: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

WorkspaceRepositoryConfiguration_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Git integration settings

Field	Description
`accountName` string	AccountName: Account name
`collaborationBranch` string	CollaborationBranch: Collaboration branch
`hostName` string	HostName: GitHub Enterprise host name. For example: `https://github.mydomain.com`
`lastCommitId` string	LastCommitId: The last commit ID
`projectName` string	ProjectName: VSTS project name
`repositoryName` string	RepositoryName: Repository name
`rootFolder` string	RootFolder: Root folder to use in the repository
`tenantId` string	TenantId: The VSTS tenant ID
`type` string	Type: Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration

Workspace_STATUS

(Appears on:Workspace)

A workspace

Field	Description
`adlaResourceId` string	AdlaResourceId: The ADLA resource ID.
`azureADOnlyAuthentication` bool	AzureADOnlyAuthentication: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`connectivityEndpoints` map[string]string	ConnectivityEndpoints: Connectivity endpoints
`cspWorkspaceAdminProperties` CspWorkspaceAdminProperties_STATUS	CspWorkspaceAdminProperties: Initial workspace AAD admin properties for a CSP subscription
`defaultDataLakeStorage` DataLakeStorageAccountDetails_STATUS	DefaultDataLakeStorage: Workspace default data lake storage account details
`encryption` EncryptionDetails_STATUS	Encryption: The encryption details of the workspace
`extraProperties` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	ExtraProperties: Workspace level configs and feature flags
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` ManagedIdentity_STATUS	Identity: Identity of the workspace
`location` string	Location: The geo-location where the resource lives
`managedResourceGroupName` string	ManagedResourceGroupName: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-’, ‘_’, ‘(’, ‘)’ and’.‘. Note that the name cannot end with ‘.’
`managedVirtualNetwork` string	ManagedVirtualNetwork: Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
`managedVirtualNetworkSettings` ManagedVirtualNetworkSettings_STATUS	ManagedVirtualNetworkSettings: Managed Virtual Network Settings
`name` string	Name: The name of the resource
`privateEndpointConnections` []PrivateEndpointConnection_STATUS	PrivateEndpointConnections: Private endpoint connections to the workspace
`provisioningState` string	ProvisioningState: Resource provisioning state
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Enable or Disable public network access to workspace
`purviewConfiguration` PurviewConfiguration_STATUS	PurviewConfiguration: Purview Configuration
`settings` map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON	Settings: Workspace settings
`sqlAdministratorLogin` string	SqlAdministratorLogin: Login for workspace SQL active directory administrator
`tags` map[string]string	Tags: Resource tags.
`trustedServiceBypassEnabled` bool	TrustedServiceBypassEnabled: Is trustedServiceBypassEnabled for the workspace
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
`virtualNetworkProfile` VirtualNetworkProfile_STATUS	VirtualNetworkProfile: Virtual Network profile
`workspaceRepositoryConfiguration` WorkspaceRepositoryConfiguration_STATUS	WorkspaceRepositoryConfiguration: Git integration settings
`workspaceUID` string	WorkspaceUID: The workspace unique identifier

Workspace_STATUS_ARM

A workspace

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` ManagedIdentity_STATUS_ARM	Identity: Identity of the workspace
`location` string	Location: The geo-location where the resource lives
`name` string	Name: The name of the resource
`properties` WorkspaceProperties_STATUS_ARM	Properties: Workspace resource properties
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Workspace_Spec

(Appears on:Workspace)

Field	Description
`azureADOnlyAuthentication` bool	AzureADOnlyAuthentication: Enable or Disable AzureADOnlyAuthentication on All Workspace subresource
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`cspWorkspaceAdminProperties` CspWorkspaceAdminProperties	CspWorkspaceAdminProperties: Initial workspace AAD admin properties for a CSP subscription
`defaultDataLakeStorage` DataLakeStorageAccountDetails	DefaultDataLakeStorage: Workspace default data lake storage account details
`encryption` EncryptionDetails	Encryption: The encryption details of the workspace
`identity` ManagedIdentity	Identity: Identity of the workspace
`location` string	Location: The geo-location where the resource lives
`managedResourceGroupName` string	ManagedResourceGroupName: Workspace managed resource group. The resource group name uniquely identifies the resource group within the user subscriptionId. The resource group name must be no longer than 90 characters long, and must be alphanumeric characters (Char.IsLetterOrDigit()) and ‘-’, ‘_’, ‘(’, ‘)’ and’.‘. Note that the name cannot end with ‘.’
`managedVirtualNetwork` string	ManagedVirtualNetwork: Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.
`managedVirtualNetworkSettings` ManagedVirtualNetworkSettings	ManagedVirtualNetworkSettings: Managed Virtual Network Settings
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` WorkspaceProperties_PublicNetworkAccess	PublicNetworkAccess: Enable or Disable public network access to workspace
`purviewConfiguration` PurviewConfiguration	PurviewConfiguration: Purview Configuration
`sqlAdministratorLogin` string	SqlAdministratorLogin: Login for workspace SQL active directory administrator
`sqlAdministratorLoginPassword` genruntime.SecretReference	SqlAdministratorLoginPassword: SQL administrator login password
`tags` map[string]string	Tags: Resource tags.
`trustedServiceBypassEnabled` bool	TrustedServiceBypassEnabled: Is trustedServiceBypassEnabled for the workspace
`virtualNetworkProfile` VirtualNetworkProfile	VirtualNetworkProfile: Virtual Network profile
`workspaceRepositoryConfiguration` WorkspaceRepositoryConfiguration	WorkspaceRepositoryConfiguration: Git integration settings

Workspace_Spec_ARM

Field	Description
`identity` ManagedIdentity_ARM	Identity: Identity of the workspace
`location` string	Location: The geo-location where the resource lives
`name` string
`properties` WorkspaceProperties_ARM	Properties: Workspace resource properties
`tags` map[string]string	Tags: Resource tags.

WorkspacesBigDataPool

Generator information: - Generated from: /synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/bigDataPool.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/bigDataPools/{bigDataPoolName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Workspaces_BigDataPool_Spec

`autoPause` AutoPauseProperties	AutoPause: Auto-pausing properties
`autoScale` AutoScaleProperties	AutoScale: Auto-scaling properties
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`cacheSize` int	CacheSize: The cache size
`customLibraries` []LibraryInfo	CustomLibraries: List of custom libraries/packages associated with the spark pool.
`defaultSparkLogFolder` string	DefaultSparkLogFolder: The default folder where Spark logs will be written.
`dynamicExecutorAllocation` DynamicExecutorAllocation	DynamicExecutorAllocation: Dynamic Executor Allocation
`isAutotuneEnabled` bool	IsAutotuneEnabled: Whether autotune is required or not.
`isComputeIsolationEnabled` bool	IsComputeIsolationEnabled: Whether compute isolation is required or not.
`libraryRequirements` LibraryRequirements	LibraryRequirements: Library version requirements
`location` string	Location: The geo-location where the resource lives
`nodeCount` int	NodeCount: The number of nodes in the Big Data pool.
`nodeSize` BigDataPoolResourceProperties_NodeSize	NodeSize: The level of compute power that each node in the Big Data pool has.
`nodeSizeFamily` BigDataPoolResourceProperties_NodeSizeFamily	NodeSizeFamily: The kind of nodes that the Big Data pool provides.
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a synapse.azure.com/Workspace resource
`provisioningState` string	ProvisioningState: The state of the Big Data pool.
`sessionLevelPackagesEnabled` bool	SessionLevelPackagesEnabled: Whether session level packages enabled.
`sparkConfigProperties` SparkConfigProperties	SparkConfigProperties: Spark configuration file to specify additional properties
`sparkEventsFolder` string	SparkEventsFolder: The Spark events folder
`sparkVersion` string	SparkVersion: The Apache Spark version.
`tags` map[string]string	Tags: Resource tags.

status
Workspaces_BigDataPool_STATUS

Workspaces_BigDataPool_STATUS

(Appears on:WorkspacesBigDataPool)

Field	Description
`autoPause` AutoPauseProperties_STATUS	AutoPause: Auto-pausing properties
`autoScale` AutoScaleProperties_STATUS	AutoScale: Auto-scaling properties
`cacheSize` int	CacheSize: The cache size
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`creationDate` string	CreationDate: The time when the Big Data pool was created.
`customLibraries` []LibraryInfo_STATUS	CustomLibraries: List of custom libraries/packages associated with the spark pool.
`defaultSparkLogFolder` string	DefaultSparkLogFolder: The default folder where Spark logs will be written.
`dynamicExecutorAllocation` DynamicExecutorAllocation_STATUS	DynamicExecutorAllocation: Dynamic Executor Allocation
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`isAutotuneEnabled` bool	IsAutotuneEnabled: Whether autotune is required or not.
`isComputeIsolationEnabled` bool	IsComputeIsolationEnabled: Whether compute isolation is required or not.
`lastSucceededTimestamp` string	LastSucceededTimestamp: The time when the Big Data pool was updated successfully.
`libraryRequirements` LibraryRequirements_STATUS	LibraryRequirements: Library version requirements
`location` string	Location: The geo-location where the resource lives
`name` string	Name: The name of the resource
`nodeCount` int	NodeCount: The number of nodes in the Big Data pool.
`nodeSize` BigDataPoolResourceProperties_NodeSize_STATUS	NodeSize: The level of compute power that each node in the Big Data pool has.
`nodeSizeFamily` BigDataPoolResourceProperties_NodeSizeFamily_STATUS	NodeSizeFamily: The kind of nodes that the Big Data pool provides.
`provisioningState` string	ProvisioningState: The state of the Big Data pool.
`sessionLevelPackagesEnabled` bool	SessionLevelPackagesEnabled: Whether session level packages enabled.
`sparkConfigProperties` SparkConfigProperties_STATUS	SparkConfigProperties: Spark configuration file to specify additional properties
`sparkEventsFolder` string	SparkEventsFolder: The Spark events folder
`sparkVersion` string	SparkVersion: The Apache Spark version.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Workspaces_BigDataPool_STATUS_ARM

Field	Description
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`location` string	Location: The geo-location where the resource lives
`name` string	Name: The name of the resource
`properties` BigDataPoolResourceProperties_STATUS_ARM	Properties: Big Data pool properties
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

Workspaces_BigDataPool_Spec

(Appears on:WorkspacesBigDataPool)

Field	Description
`autoPause` AutoPauseProperties	AutoPause: Auto-pausing properties
`autoScale` AutoScaleProperties	AutoScale: Auto-scaling properties
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`cacheSize` int	CacheSize: The cache size
`customLibraries` []LibraryInfo	CustomLibraries: List of custom libraries/packages associated with the spark pool.
`defaultSparkLogFolder` string	DefaultSparkLogFolder: The default folder where Spark logs will be written.
`dynamicExecutorAllocation` DynamicExecutorAllocation	DynamicExecutorAllocation: Dynamic Executor Allocation
`isAutotuneEnabled` bool	IsAutotuneEnabled: Whether autotune is required or not.
`isComputeIsolationEnabled` bool	IsComputeIsolationEnabled: Whether compute isolation is required or not.
`libraryRequirements` LibraryRequirements	LibraryRequirements: Library version requirements
`location` string	Location: The geo-location where the resource lives
`nodeCount` int	NodeCount: The number of nodes in the Big Data pool.
`nodeSize` BigDataPoolResourceProperties_NodeSize	NodeSize: The level of compute power that each node in the Big Data pool has.
`nodeSizeFamily` BigDataPoolResourceProperties_NodeSizeFamily	NodeSizeFamily: The kind of nodes that the Big Data pool provides.
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a synapse.azure.com/Workspace resource
`provisioningState` string	ProvisioningState: The state of the Big Data pool.
`sessionLevelPackagesEnabled` bool	SessionLevelPackagesEnabled: Whether session level packages enabled.
`sparkConfigProperties` SparkConfigProperties	SparkConfigProperties: Spark configuration file to specify additional properties
`sparkEventsFolder` string	SparkEventsFolder: The Spark events folder
`sparkVersion` string	SparkVersion: The Apache Spark version.
`tags` map[string]string	Tags: Resource tags.

Workspaces_BigDataPool_Spec_ARM

Field	Description
`location` string	Location: The geo-location where the resource lives
`name` string
`properties` BigDataPoolResourceProperties_ARM	Properties: Big Data pool properties
`tags` map[string]string	Tags: Resource tags.

synapse.azure.com/v1api20210601