Share via


SynapseWorkspaceData Class

Definition

A class representing the SynapseWorkspace data model. A workspace

public class SynapseWorkspaceData : Azure.ResourceManager.Models.TrackedResourceData
type SynapseWorkspaceData = class
    inherit TrackedResourceData
Public Class SynapseWorkspaceData
Inherits TrackedResourceData
Inheritance
SynapseWorkspaceData

Constructors

SynapseWorkspaceData(AzureLocation)

Initializes a new instance of SynapseWorkspaceData.

Properties

AdlaResourceId

The ADLA resource ID.

ConnectivityEndpoints

Connectivity endpoints.

DefaultDataLakeStorage

Workspace default data lake storage account details.

Encryption

The encryption details of the workspace.

ExtraProperties

Workspace level configs and feature flags

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

Identity of the workspace. Current supported identity types: None, SystemAssigned, SystemAssigned,UserAssigned.

InitialWorkspaceAdminObjectId

AAD object ID of initial workspace admin.

IsAadOnlyAuthenticationEnabled

Enable or Disable AzureADOnlyAuthentication on All Workspace subresource.

IsTrustedServiceBypassEnabled

Is trustedServiceBypassEnabled for the workspace.

Location

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
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

Setting this to 'default' will ensure that all compute for this workspace is in a virtual network managed on behalf of the user.

ManagedVirtualNetworkSettings

Managed Virtual Network Settings.

Name

The name of the resource.

(Inherited from ResourceData)
PrivateEndpointConnections

Private endpoint connections to the workspace.

ProvisioningState

Resource provisioning state.

PublicNetworkAccess

Enable or Disable public network access to workspace.

PurviewResourceId

Purview Resource ID.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
Settings

Workspace settings

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
SqlAdministratorLogin

Login for workspace SQL active directory administrator.

SqlAdministratorLoginPassword

SQL administrator login password.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)
VirtualNetworkComputeSubnetId

Subnet ID used for computes in workspace.

WorkspaceRepositoryConfiguration

Git integration settings.

WorkspaceUid

The workspace unique identifier.

Applies to