synapse.azure.com/v1api20210601
APIVersion
| Value | Description |
|---|---|
| “2021-06-01” |
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}
Used by: WorkspaceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Workspace_Spec Optional |
|
| status | Workspace_STATUS Optional |
Workspace_Spec
| Property | Description | Type |
|---|---|---|
| azureADOnlyAuthentication | Enable or Disable AzureADOnlyAuthentication on All Workspace subresource | bool Optional |
| 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. | string Optional |
| cspWorkspaceAdminProperties | Initial workspace AAD admin properties for a CSP subscription | CspWorkspaceAdminProperties Optional |
| defaultDataLakeStorage | Workspace default data lake storage account details | DataLakeStorageAccountDetails Optional |
| encryption | The encryption details of the workspace | EncryptionDetails Optional |
| identity | Identity of the workspace | ManagedIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| 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 ‘.’ | string Optional |
| managedVirtualNetwork | Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. | string Optional |
| managedVirtualNetworkSettings | Managed Virtual Network Settings | ManagedVirtualNetworkSettings Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WorkspaceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| publicNetworkAccess | Enable or Disable public network access to workspace | WorkspaceProperties_PublicNetworkAccess Optional |
| purviewConfiguration | Purview Configuration | PurviewConfiguration Optional |
| sqlAdministratorLogin | Login for workspace SQL active directory administrator | string Optional |
| sqlAdministratorLoginPassword | SQL administrator login password | genruntime.SecretReference Optional |
| tags | Resource tags. | map[string]string Optional |
| trustedServiceBypassEnabled | Is trustedServiceBypassEnabled for the workspace | bool Optional |
| virtualNetworkProfile | Virtual Network profile | VirtualNetworkProfile Optional |
| workspaceRepositoryConfiguration | Git integration settings | WorkspaceRepositoryConfiguration Optional |
Workspace_STATUS
| Property | Description | Type |
|---|---|---|
| adlaResourceId | The ADLA resource ID. | string Optional |
| azureADOnlyAuthentication | Enable or Disable AzureADOnlyAuthentication on All Workspace subresource | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| connectivityEndpoints | Connectivity endpoints | map[string]string Optional |
| cspWorkspaceAdminProperties | Initial workspace AAD admin properties for a CSP subscription | CspWorkspaceAdminProperties_STATUS Optional |
| defaultDataLakeStorage | Workspace default data lake storage account details | DataLakeStorageAccountDetails_STATUS Optional |
| encryption | The encryption details of the workspace | EncryptionDetails_STATUS Optional |
| extraProperties | Workspace level configs and feature flags | map[string]v1.JSON Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity of the workspace | ManagedIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| 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 ‘.’ | string Optional |
| managedVirtualNetwork | Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. | string Optional |
| managedVirtualNetworkSettings | Managed Virtual Network Settings | ManagedVirtualNetworkSettings_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | Private endpoint connections to the workspace | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Resource provisioning state | string Optional |
| publicNetworkAccess | Enable or Disable public network access to workspace | WorkspaceProperties_PublicNetworkAccess_STATUS Optional |
| purviewConfiguration | Purview Configuration | PurviewConfiguration_STATUS Optional |
| settings | Workspace settings | map[string]v1.JSON Optional |
| sqlAdministratorLogin | Login for workspace SQL active directory administrator | string Optional |
| tags | Resource tags. | map[string]string Optional |
| trustedServiceBypassEnabled | Is trustedServiceBypassEnabled for the workspace | bool Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| virtualNetworkProfile | Virtual Network profile | VirtualNetworkProfile_STATUS Optional |
| workspaceRepositoryConfiguration | Git integration settings | WorkspaceRepositoryConfiguration_STATUS Optional |
| workspaceUID | The workspace unique identifier | string Optional |
WorkspaceList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Workspace[] Optional |
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}
Used by: WorkspacesBigDataPoolList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | WorkspacesBigDataPool_Spec Optional |
|
| status | WorkspacesBigDataPool_STATUS Optional |
WorkspacesBigDataPool_Spec
| Property | Description | Type |
|---|---|---|
| autoPause | Auto-pausing properties | AutoPauseProperties Optional |
| autoScale | Auto-scaling properties | AutoScaleProperties Optional |
| 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. | string Optional |
| cacheSize | The cache size | int Optional |
| customLibraries | List of custom libraries/packages associated with the spark pool. | LibraryInfo[] Optional |
| defaultSparkLogFolder | The default folder where Spark logs will be written. | string Optional |
| dynamicExecutorAllocation | Dynamic Executor Allocation | DynamicExecutorAllocation Optional |
| isAutotuneEnabled | Whether autotune is required or not. | bool Optional |
| isComputeIsolationEnabled | Whether compute isolation is required or not. | bool Optional |
| libraryRequirements | Library version requirements | LibraryRequirements Optional |
| location | The geo-location where the resource lives | string Required |
| nodeCount | The number of nodes in the Big Data pool. | int Optional |
| nodeSize | The level of compute power that each node in the Big Data pool has. | BigDataPoolResourceProperties_NodeSize Optional |
| nodeSizeFamily | The kind of nodes that the Big Data pool provides. | BigDataPoolResourceProperties_NodeSizeFamily Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WorkspacesBigDataPoolOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| provisioningState | The state of the Big Data pool. | string Optional |
| sessionLevelPackagesEnabled | Whether session level packages enabled. | bool Optional |
| sparkConfigProperties | Spark configuration file to specify additional properties | SparkConfigProperties Optional |
| sparkEventsFolder | The Spark events folder | string Optional |
| sparkVersion | The Apache Spark version. | string Optional |
| tags | Resource tags. | map[string]string Optional |
WorkspacesBigDataPool_STATUS
| Property | Description | Type |
|---|---|---|
| autoPause | Auto-pausing properties | AutoPauseProperties_STATUS Optional |
| autoScale | Auto-scaling properties | AutoScaleProperties_STATUS Optional |
| cacheSize | The cache size | int Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| creationDate | The time when the Big Data pool was created. | string Optional |
| customLibraries | List of custom libraries/packages associated with the spark pool. | LibraryInfo_STATUS[] Optional |
| defaultSparkLogFolder | The default folder where Spark logs will be written. | string Optional |
| dynamicExecutorAllocation | Dynamic Executor Allocation | DynamicExecutorAllocation_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isAutotuneEnabled | Whether autotune is required or not. | bool Optional |
| isComputeIsolationEnabled | Whether compute isolation is required or not. | bool Optional |
| lastSucceededTimestamp | The time when the Big Data pool was updated successfully. | string Optional |
| libraryRequirements | Library version requirements | LibraryRequirements_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| nodeCount | The number of nodes in the Big Data pool. | int Optional |
| nodeSize | The level of compute power that each node in the Big Data pool has. | BigDataPoolResourceProperties_NodeSize_STATUS Optional |
| nodeSizeFamily | The kind of nodes that the Big Data pool provides. | BigDataPoolResourceProperties_NodeSizeFamily_STATUS Optional |
| provisioningState | The state of the Big Data pool. | string Optional |
| sessionLevelPackagesEnabled | Whether session level packages enabled. | bool Optional |
| sparkConfigProperties | Spark configuration file to specify additional properties | SparkConfigProperties_STATUS Optional |
| sparkEventsFolder | The Spark events folder | string Optional |
| sparkVersion | The Apache Spark version. | string Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
WorkspacesBigDataPoolList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | WorkspacesBigDataPool[] Optional |
Workspace_Spec
Used by: Workspace.
| Property | Description | Type |
|---|---|---|
| azureADOnlyAuthentication | Enable or Disable AzureADOnlyAuthentication on All Workspace subresource | bool Optional |
| 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. | string Optional |
| cspWorkspaceAdminProperties | Initial workspace AAD admin properties for a CSP subscription | CspWorkspaceAdminProperties Optional |
| defaultDataLakeStorage | Workspace default data lake storage account details | DataLakeStorageAccountDetails Optional |
| encryption | The encryption details of the workspace | EncryptionDetails Optional |
| identity | Identity of the workspace | ManagedIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| 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 ‘.’ | string Optional |
| managedVirtualNetwork | Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. | string Optional |
| managedVirtualNetworkSettings | Managed Virtual Network Settings | ManagedVirtualNetworkSettings Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WorkspaceOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| publicNetworkAccess | Enable or Disable public network access to workspace | WorkspaceProperties_PublicNetworkAccess Optional |
| purviewConfiguration | Purview Configuration | PurviewConfiguration Optional |
| sqlAdministratorLogin | Login for workspace SQL active directory administrator | string Optional |
| sqlAdministratorLoginPassword | SQL administrator login password | genruntime.SecretReference Optional |
| tags | Resource tags. | map[string]string Optional |
| trustedServiceBypassEnabled | Is trustedServiceBypassEnabled for the workspace | bool Optional |
| virtualNetworkProfile | Virtual Network profile | VirtualNetworkProfile Optional |
| workspaceRepositoryConfiguration | Git integration settings | WorkspaceRepositoryConfiguration Optional |
Workspace_STATUS
A workspace
Used by: Workspace.
| Property | Description | Type |
|---|---|---|
| adlaResourceId | The ADLA resource ID. | string Optional |
| azureADOnlyAuthentication | Enable or Disable AzureADOnlyAuthentication on All Workspace subresource | bool Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| connectivityEndpoints | Connectivity endpoints | map[string]string Optional |
| cspWorkspaceAdminProperties | Initial workspace AAD admin properties for a CSP subscription | CspWorkspaceAdminProperties_STATUS Optional |
| defaultDataLakeStorage | Workspace default data lake storage account details | DataLakeStorageAccountDetails_STATUS Optional |
| encryption | The encryption details of the workspace | EncryptionDetails_STATUS Optional |
| extraProperties | Workspace level configs and feature flags | map[string]v1.JSON Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | Identity of the workspace | ManagedIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| 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 ‘.’ | string Optional |
| managedVirtualNetwork | Setting this to ‘default’ will ensure that all compute for this workspace is in a virtual network managed on behalf of the user. | string Optional |
| managedVirtualNetworkSettings | Managed Virtual Network Settings | ManagedVirtualNetworkSettings_STATUS Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | Private endpoint connections to the workspace | PrivateEndpointConnection_STATUS[] Optional |
| provisioningState | Resource provisioning state | string Optional |
| publicNetworkAccess | Enable or Disable public network access to workspace | WorkspaceProperties_PublicNetworkAccess_STATUS Optional |
| purviewConfiguration | Purview Configuration | PurviewConfiguration_STATUS Optional |
| settings | Workspace settings | map[string]v1.JSON Optional |
| sqlAdministratorLogin | Login for workspace SQL active directory administrator | string Optional |
| tags | Resource tags. | map[string]string Optional |
| trustedServiceBypassEnabled | Is trustedServiceBypassEnabled for the workspace | bool Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| virtualNetworkProfile | Virtual Network profile | VirtualNetworkProfile_STATUS Optional |
| workspaceRepositoryConfiguration | Git integration settings | WorkspaceRepositoryConfiguration_STATUS Optional |
| workspaceUID | The workspace unique identifier | string Optional |
WorkspacesBigDataPool_Spec
Used by: WorkspacesBigDataPool.
| Property | Description | Type |
|---|---|---|
| autoPause | Auto-pausing properties | AutoPauseProperties Optional |
| autoScale | Auto-scaling properties | AutoScaleProperties Optional |
| 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. | string Optional |
| cacheSize | The cache size | int Optional |
| customLibraries | List of custom libraries/packages associated with the spark pool. | LibraryInfo[] Optional |
| defaultSparkLogFolder | The default folder where Spark logs will be written. | string Optional |
| dynamicExecutorAllocation | Dynamic Executor Allocation | DynamicExecutorAllocation Optional |
| isAutotuneEnabled | Whether autotune is required or not. | bool Optional |
| isComputeIsolationEnabled | Whether compute isolation is required or not. | bool Optional |
| libraryRequirements | Library version requirements | LibraryRequirements Optional |
| location | The geo-location where the resource lives | string Required |
| nodeCount | The number of nodes in the Big Data pool. | int Optional |
| nodeSize | The level of compute power that each node in the Big Data pool has. | BigDataPoolResourceProperties_NodeSize Optional |
| nodeSizeFamily | The kind of nodes that the Big Data pool provides. | BigDataPoolResourceProperties_NodeSizeFamily Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | WorkspacesBigDataPoolOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| provisioningState | The state of the Big Data pool. | string Optional |
| sessionLevelPackagesEnabled | Whether session level packages enabled. | bool Optional |
| sparkConfigProperties | Spark configuration file to specify additional properties | SparkConfigProperties Optional |
| sparkEventsFolder | The Spark events folder | string Optional |
| sparkVersion | The Apache Spark version. | string Optional |
| tags | Resource tags. | map[string]string Optional |
WorkspacesBigDataPool_STATUS
Used by: WorkspacesBigDataPool.
| Property | Description | Type |
|---|---|---|
| autoPause | Auto-pausing properties | AutoPauseProperties_STATUS Optional |
| autoScale | Auto-scaling properties | AutoScaleProperties_STATUS Optional |
| cacheSize | The cache size | int Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| creationDate | The time when the Big Data pool was created. | string Optional |
| customLibraries | List of custom libraries/packages associated with the spark pool. | LibraryInfo_STATUS[] Optional |
| defaultSparkLogFolder | The default folder where Spark logs will be written. | string Optional |
| dynamicExecutorAllocation | Dynamic Executor Allocation | DynamicExecutorAllocation_STATUS Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| isAutotuneEnabled | Whether autotune is required or not. | bool Optional |
| isComputeIsolationEnabled | Whether compute isolation is required or not. | bool Optional |
| lastSucceededTimestamp | The time when the Big Data pool was updated successfully. | string Optional |
| libraryRequirements | Library version requirements | LibraryRequirements_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| nodeCount | The number of nodes in the Big Data pool. | int Optional |
| nodeSize | The level of compute power that each node in the Big Data pool has. | BigDataPoolResourceProperties_NodeSize_STATUS Optional |
| nodeSizeFamily | The kind of nodes that the Big Data pool provides. | BigDataPoolResourceProperties_NodeSizeFamily_STATUS Optional |
| provisioningState | The state of the Big Data pool. | string Optional |
| sessionLevelPackagesEnabled | Whether session level packages enabled. | bool Optional |
| sparkConfigProperties | Spark configuration file to specify additional properties | SparkConfigProperties_STATUS Optional |
| sparkEventsFolder | The Spark events folder | string Optional |
| sparkVersion | The Apache Spark version. | string Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
AutoPauseProperties
Auto-pausing properties of a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| delayInMinutes | Number of minutes of idle time before the Big Data pool is automatically paused. | int Optional |
| enabled | Whether auto-pausing is enabled for the Big Data pool. | bool Optional |
AutoPauseProperties_STATUS
Auto-pausing properties of a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_STATUS.
| Property | Description | Type |
|---|---|---|
| delayInMinutes | Number of minutes of idle time before the Big Data pool is automatically paused. | int Optional |
| enabled | Whether auto-pausing is enabled for the Big Data pool. | bool Optional |
AutoScaleProperties
Auto-scaling properties of a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| enabled | Whether automatic scaling is enabled for the Big Data pool. | bool Optional |
| maxNodeCount | The maximum number of nodes the Big Data pool can support. | int Optional |
| minNodeCount | The minimum number of nodes the Big Data pool can support. | int Optional |
AutoScaleProperties_STATUS
Auto-scaling properties of a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_STATUS.
| Property | Description | Type |
|---|---|---|
| enabled | Whether automatic scaling is enabled for the Big Data pool. | bool Optional |
| maxNodeCount | The maximum number of nodes the Big Data pool can support. | int Optional |
| minNodeCount | The minimum number of nodes the Big Data pool can support. | int Optional |
BigDataPoolResourceProperties_NodeSize
Used by: WorkspacesBigDataPool_Spec.
| Value | Description |
|---|---|
| “Large” | |
| “Medium” | |
| “None” | |
| “Small” | |
| “XLarge” | |
| “XXLarge” | |
| “XXXLarge” |
BigDataPoolResourceProperties_NodeSize_STATUS
Used by: WorkspacesBigDataPool_STATUS.
| Value | Description |
|---|---|
| “Large” | |
| “Medium” | |
| “None” | |
| “Small” | |
| “XLarge” | |
| “XXLarge” | |
| “XXXLarge” |
BigDataPoolResourceProperties_NodeSizeFamily
Used by: WorkspacesBigDataPool_Spec.
| Value | Description |
|---|---|
| “HardwareAcceleratedFPGA” | |
| “HardwareAcceleratedGPU” | |
| “MemoryOptimized” | |
| “None” |
BigDataPoolResourceProperties_NodeSizeFamily_STATUS
Used by: WorkspacesBigDataPool_STATUS.
| Value | Description |
|---|---|
| “HardwareAcceleratedFPGA” | |
| “HardwareAcceleratedGPU” | |
| “MemoryOptimized” | |
| “None” |
CspWorkspaceAdminProperties
Initial workspace AAD admin properties for a CSP subscription
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| initialWorkspaceAdminObjectId | AAD object ID of initial workspace admin | string Optional |
CspWorkspaceAdminProperties_STATUS
Initial workspace AAD admin properties for a CSP subscription
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| initialWorkspaceAdminObjectId | AAD object ID of initial workspace admin | string Optional |
DataLakeStorageAccountDetails
Details of the data lake storage account associated with the workspace
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| accountUrl | Account URL | string Optional |
| accountUrlFromConfig | Account URL | genruntime.ConfigMapReference Optional |
| createManagedPrivateEndpoint | Create managed private endpoint to this storage account or not | bool Optional |
| filesystem | Filesystem name | string Optional |
| resourceReference | ARM resource Id of this storage account | genruntime.ResourceReference Optional |
DataLakeStorageAccountDetails_STATUS
Details of the data lake storage account associated with the workspace
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| accountUrl | Account URL | string Optional |
| createManagedPrivateEndpoint | Create managed private endpoint to this storage account or not | bool Optional |
| filesystem | Filesystem name | string Optional |
| resourceId | ARM resource Id of this storage account | string Optional |
DynamicExecutorAllocation
Dynamic Executor Allocation Properties
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| enabled | Indicates whether Dynamic Executor Allocation is enabled or not. | bool Optional |
| maxExecutors | The maximum number of executors alloted | int Optional |
| minExecutors | The minimum number of executors alloted | int Optional |
DynamicExecutorAllocation_STATUS
Dynamic Executor Allocation Properties
Used by: WorkspacesBigDataPool_STATUS.
| Property | Description | Type |
|---|---|---|
| enabled | Indicates whether Dynamic Executor Allocation is enabled or not. | bool Optional |
| maxExecutors | The maximum number of executors alloted | int Optional |
| minExecutors | The minimum number of executors alloted | int Optional |
EncryptionDetails
Details of the encryption associated with the workspace
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| cmk | Customer Managed Key Details | CustomerManagedKeyDetails Optional |
EncryptionDetails_STATUS
Details of the encryption associated with the workspace
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| cmk | Customer Managed Key Details | CustomerManagedKeyDetails_STATUS Optional |
| doubleEncryptionEnabled | Double Encryption enabled | bool Optional |
LibraryInfo
Library/package information of a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| containerName | Storage blob container name. | string Optional |
| name | Name of the library. | string Optional |
| path | Storage blob path of library. | string Optional |
| type | Type of the library. | string Optional |
LibraryInfo_STATUS
Library/package information of a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_STATUS.
| Property | Description | Type |
|---|---|---|
| containerName | Storage blob container name. | string Optional |
| creatorId | Creator Id of the library/package. | string Optional |
| name | Name of the library. | string Optional |
| path | Storage blob path of library. | string Optional |
| provisioningStatus | Provisioning status of the library/package. | string Optional |
| type | Type of the library. | string Optional |
| uploadedTimestamp | The last update time of the library. | string Optional |
LibraryRequirements
Library requirements for a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| content | The library requirements. | string Optional |
| filename | The filename of the library requirements file. | string Optional |
LibraryRequirements_STATUS
Library requirements for a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_STATUS.
| Property | Description | Type |
|---|---|---|
| content | The library requirements. | string Optional |
| filename | The filename of the library requirements file. | string Optional |
| time | The last update time of the library requirements file. | string Optional |
ManagedIdentity
The workspace managed identity
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| type | The type of managed identity for the workspace | ManagedIdentity_Type Optional |
| userAssignedIdentities | The user assigned managed identities. | UserAssignedIdentityDetails[] Optional |
ManagedIdentity_STATUS
The workspace managed identity
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal ID of the workspace managed identity | string Optional |
| tenantId | The tenant ID of the workspace managed identity | string Optional |
| type | The type of managed identity for the workspace | ManagedIdentity_Type_STATUS Optional |
| userAssignedIdentities | The user assigned managed identities. | map[string]UserAssignedManagedIdentity_STATUS Optional |
ManagedVirtualNetworkSettings
Managed Virtual Network Settings
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| allowedAadTenantIdsForLinking | Allowed Aad Tenant Ids For Linking | string[] Optional |
| linkedAccessCheckOnTargetResource | Linked Access Check On Target Resource | bool Optional |
| preventDataExfiltration | Prevent Data Exfiltration | bool Optional |
ManagedVirtualNetworkSettings_STATUS
Managed Virtual Network Settings
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| allowedAadTenantIdsForLinking | Allowed Aad Tenant Ids For Linking | string[] Optional |
| linkedAccessCheckOnTargetResource | Linked Access Check On Target Resource | bool Optional |
| preventDataExfiltration | Prevent Data Exfiltration | bool Optional |
PrivateEndpointConnection_STATUS
A private endpoint connection
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
PurviewConfiguration
Purview Configuration
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| purviewResourceReference | Purview Resource ID | genruntime.ResourceReference Optional |
PurviewConfiguration_STATUS
Purview Configuration
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| purviewResourceId | Purview Resource ID | string Optional |
SparkConfigProperties
SparkConfig Properties for a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| configurationType | The type of the spark config properties file. | SparkConfigProperties_ConfigurationType Optional |
| content | The spark config properties. | string Optional |
| filename | The filename of the spark config properties file. | string Optional |
SparkConfigProperties_STATUS
SparkConfig Properties for a Big Data pool powered by Apache Spark
Used by: WorkspacesBigDataPool_STATUS.
| Property | Description | Type |
|---|---|---|
| configurationType | The type of the spark config properties file. | SparkConfigProperties_ConfigurationType_STATUS Optional |
| content | The spark config properties. | string Optional |
| filename | The filename of the spark config properties file. | string Optional |
| time | The last update time of the spark config properties file. | string Optional |
VirtualNetworkProfile
Virtual Network Profile
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| computeSubnetId | Subnet ID used for computes in workspace | string Optional |
VirtualNetworkProfile_STATUS
Virtual Network Profile
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| computeSubnetId | Subnet ID used for computes in workspace | string Optional |
WorkspaceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
WorkspaceProperties_PublicNetworkAccess
Used by: Workspace_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
WorkspaceProperties_PublicNetworkAccess_STATUS
Used by: Workspace_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
WorkspaceRepositoryConfiguration
Git integration settings
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| accountName | Account name | string Optional |
| collaborationBranch | Collaboration branch | string Optional |
| hostName | GitHub Enterprise host name. For example: https://github.mydomain.com |
string Optional |
| lastCommitId | The last commit ID | string Optional |
| projectName | VSTS project name | string Optional |
| repositoryName | Repository name | string Optional |
| rootFolder | Root folder to use in the repository | string Optional |
| tenantId | The VSTS tenant ID | string Optional |
| type | Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration | string Optional |
WorkspaceRepositoryConfiguration_STATUS
Git integration settings
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| accountName | Account name | string Optional |
| collaborationBranch | Collaboration branch | string Optional |
| hostName | GitHub Enterprise host name. For example: https://github.mydomain.com |
string Optional |
| lastCommitId | The last commit ID | string Optional |
| projectName | VSTS project name | string Optional |
| repositoryName | Repository name | string Optional |
| rootFolder | Root folder to use in the repository | string Optional |
| tenantId | The VSTS tenant ID | string Optional |
| type | Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration | string Optional |
WorkspacesBigDataPoolOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: WorkspacesBigDataPool_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
CustomerManagedKeyDetails
Details of the customer managed key associated with the workspace
Used by: EncryptionDetails.
| Property | Description | Type |
|---|---|---|
| kekIdentity | Key encryption key | KekIdentityProperties Optional |
| key | The key object of the workspace | WorkspaceKeyDetails Optional |
CustomerManagedKeyDetails_STATUS
Details of the customer managed key associated with the workspace
Used by: EncryptionDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| kekIdentity | Key encryption key | KekIdentityProperties_STATUS Optional |
| key | The key object of the workspace | WorkspaceKeyDetails_STATUS Optional |
| status | The customer managed key status on the workspace | string Optional |
ManagedIdentity_Type
Used by: ManagedIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” |
ManagedIdentity_Type_STATUS
Used by: ManagedIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” |
SparkConfigProperties_ConfigurationType
Used by: SparkConfigProperties.
| Value | Description |
|---|---|
| “Artifact” | |
| “File” |
SparkConfigProperties_ConfigurationType_STATUS
Used by: SparkConfigProperties_STATUS.
| Value | Description |
|---|---|
| “Artifact” | |
| “File” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserAssignedManagedIdentity_STATUS
User Assigned Managed Identity
Used by: ManagedIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID. | string Optional |
| principalId | The principal ID. | string Optional |
KekIdentityProperties
Key encryption key properties
Used by: CustomerManagedKeyDetails.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentityReference | User assigned identity resource Id | genruntime.ResourceReference Optional |
| useSystemAssignedIdentity | Boolean specifying whether to use system assigned identity or not | v1.JSON Optional |
KekIdentityProperties_STATUS
Key encryption key properties
Used by: CustomerManagedKeyDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| userAssignedIdentity | User assigned identity resource Id | string Optional |
| useSystemAssignedIdentity | Boolean specifying whether to use system assigned identity or not | v1.JSON Optional |
WorkspaceKeyDetails
Details of the customer managed key associated with the workspace
Used by: CustomerManagedKeyDetails.
| Property | Description | Type |
|---|---|---|
| keyVaultUrl | Workspace Key sub-resource key vault url | string Optional |
| name | Workspace Key sub-resource name | string Optional |
WorkspaceKeyDetails_STATUS
Details of the customer managed key associated with the workspace
Used by: CustomerManagedKeyDetails_STATUS.
| Property | Description | Type |
|---|---|---|
| keyVaultUrl | Workspace Key sub-resource key vault url | string Optional |
| name | Workspace Key sub-resource name | string Optional |