Workspace Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401

Assembly:: Az.MachineLearningServices.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An object that represents a machine learning workspace.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.WorkspaceTypeConverter))]
public class Workspace : Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IWorkspace, Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.WorkspaceTypeConverter))>]
type Workspace = class
    interface IWorkspace
    interface IJsonSerializable
    interface IResource
    interface IValidates

Public Class Workspace
Implements IValidates, IWorkspace

Inheritance: Object
Workspace

Attributes: TypeConverterAttribute

Implements: IWorkspace IResource IJsonSerializable IValidates

Constructors

Workspace()

Creates an new Workspace instance.

Properties

AllowPublicAccessWhenBehindVnet	The flag to indicate whether to allow public access when behind VNet.
ApplicationInsight	ARM id of the application insights associated with this workspace.
AssociatedWorkspace
ComputeRuntimeSparkRuntimeVersion
ContainerRegistry	ARM id of the container registry associated with this workspace.
CosmoDbCollectionsThroughput	The throughput of the collections in cosmosdb database
Description	The description of this workspace.
DiscoveryUrl	Url for the discovery service to identify regional endpoints for machine learning experimentation services
EnableDataIsolation
EncryptionStatus	Indicates whether or not the encryption is enabled for the workspace.
FeatureStoreSettingOfflineStoreConnectionName
FeatureStoreSettingOnlineStoreConnectionName
FriendlyName	The friendly name for this workspace. This name in mutable
HbiWorkspace	The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service
HubConfigAdditionalWorkspaceStorageAccount
HubConfigDefaultWorkspaceResourceGroup
HubResourceId
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IdentityPrincipalId	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityTenantId	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
IdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
IdentityUserAssignedIdentity	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
ImageBuildCompute	The compute name for image build
KeyVault	ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created
KeyVaultPropertyIdentityClientId	For future use - The client id of the identity which will be used to access key vault.
KeyVaultPropertyKeyIdentifier	Key vault uri to access the encryption key.
KeyVaultPropertyKeyVaultArmId	The ArmId of the keyVault where the customer owned encryption key is present.
Kind	Type of workspace. Possible values: Default, Hub, Project, FeatureStore.
Location	Specifies the location of the resource.
ManagedNetworkId
ManagedNetworkIsolationMode	Isolation mode for the managed network of a machine learning workspace.
ManagedNetworkOutboundRule
MlFlowTrackingUri	The URI associated with this workspace that machine learning flow must point at to set up tracking.
Name	The name of the resource
NotebookInfoFqdn
NotebookInfoResourceId	the data plane resourceId that used to initialize notebook component
NotebookPreparationErrorMessage
NotebookPreparationErrorStatusCode
PrimaryUserAssignedIdentity	The user assigned identity resource id that represents the workspace identity.
PrivateEndpointConnection	The list of private endpoint connections in the workspace.
PrivateLinkCount	Count of private connections in the workspace
PropertiesEncryptionIdentityUserAssignedIdentity	The ArmId of the user assigned identity that will be used to access the customer managed key vault
ProvisioningState	The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning.
PublicNetworkAccess	Whether requests from Public Network are allowed.
ResourceGroupName	Gets the resource group name
ServerlessComputeSettingServerlessComputeCustomSubnet	The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed
ServerlessComputeSettingServerlessComputeNoPublicIP	The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint
ServiceProvisionedResourceGroup	The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace
SharedPrivateLinkResource	The list of shared private link resources in this workspace.
SkuCapacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
SkuFamily	If the service has different generations of hardware, for the same SKU, then that can be captured here.
SkuName	The name of the SKU. Ex - P3. It is typically a letter+number code
SkuSize	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
Status	Status for the managed network of a machine learning workspace.
StatusSparkReady
StorageAccount	ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created
StorageHnsEnabled	If the storage associated with the workspace has hierarchical namespace(HNS) enabled.
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemDataCreatedAt	The timestamp of resource creation (UTC).
SystemDataCreatedBy	The identity that created the resource.
SystemDataCreatedByType	The type of identity that created the resource.
SystemDataLastModifiedAt	The timestamp of resource last modification (UTC)
SystemDataLastModifiedBy	The identity that last modified the resource.
SystemDataLastModifiedByType	The type of identity that last modified the resource.
Tag	Contains resource tags defined as key/value pairs.
TenantId	The tenant id associated with this workspace.
Type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
V1LegacyMode	Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.
WorkspaceId	The immutable id associated with this workspace.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of Workspace.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Workspace.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.MachineLearningServices.Models.Api20240401.IWorkspace.
FromJsonString(String)	Creates a new instance of Workspace, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Workspace into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Share via