Update-AzMLWorkspace

  • Reference
Module:
Az.MachineLearningServices

Updates a machine learning workspace with the specified parameters.

Syntax

Update-AzMLWorkspace
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-ApplicationInsightId <String>]
      [-ComputeRuntimeSparkRuntimeVersion <String>]
      [-ContainerRegistryId <String>]
      [-CosmoDbCollectionsThroughput <Int32>]
      [-Description <String>]
      [-EnableDataIsolation]
      [-FeatureStoreSettingOfflineStoreConnectionName <String>]
      [-FeatureStoreSettingOnlineStoreConnectionName <String>]
      [-FriendlyName <String>]
      [-IdentityType <ManagedServiceIdentityType>]
      [-IdentityUserAssigned <Hashtable>]
      [-ImageBuildCompute <String>]
      [-KeyVaultKeyIdentifier <String>]
      [-ManagedNetworkIsolationMode <IsolationMode>]
      [-ManagedNetworkOutboundRule <Hashtable>]
      [-PrimaryUserAssignedIdentity <String>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-ServerlessComputeSettingServerlessComputeCustomSubnet <String>]
      [-ServerlessComputeSettingServerlessComputeNoPublicIP]
      [-SkuCapacity <Int32>]
      [-SkuFamily <String>]
      [-SkuName <String>]
      [-SkuSize <String>]
      [-SkuTier <SkuTier>]
      [-Status <ManagedNetworkStatus>]
      [-StatusSparkReady]
      [-Tag <Hashtable>]
      [-V1LegacyMode]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzMLWorkspace
      -InputObject <IMachineLearningServicesIdentity>
      [-ApplicationInsightId <String>]
      [-ComputeRuntimeSparkRuntimeVersion <String>]
      [-ContainerRegistryId <String>]
      [-CosmoDbCollectionsThroughput <Int32>]
      [-Description <String>]
      [-EnableDataIsolation]
      [-FeatureStoreSettingOfflineStoreConnectionName <String>]
      [-FeatureStoreSettingOnlineStoreConnectionName <String>]
      [-FriendlyName <String>]
      [-IdentityType <ManagedServiceIdentityType>]
      [-IdentityUserAssigned <Hashtable>]
      [-ImageBuildCompute <String>]
      [-KeyVaultKeyIdentifier <String>]
      [-ManagedNetworkIsolationMode <IsolationMode>]
      [-ManagedNetworkOutboundRule <Hashtable>]
      [-PrimaryUserAssignedIdentity <String>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-ServerlessComputeSettingServerlessComputeCustomSubnet <String>]
      [-ServerlessComputeSettingServerlessComputeNoPublicIP]
      [-SkuCapacity <Int32>]
      [-SkuFamily <String>]
      [-SkuName <String>]
      [-SkuSize <String>]
      [-SkuTier <SkuTier>]
      [-Status <ManagedNetworkStatus>]
      [-StatusSparkReady]
      [-Tag <Hashtable>]
      [-V1LegacyMode]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a machine learning workspace with the specified parameters.

Examples

Example 1: Updates a machine learning workspace with the specified parameters

Update-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlwork01 -Tag @{'key1' = 'value2'}

Name     SystemDataCreatedAt SystemDataCreatedBy   SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Kind    Location ResourceGroupName     
----     ------------------- -------------------   ----------------------- ------------------------ ------------------------ ---------------------------- ----    -------- -----------------     
mlwork01 6/6/2024 9:40:20 AM user@example.com      User                    6/7/2024 3:57:23 AM      user@example.com         User                         Default eastus   ml-rg-test

This command updates a machine learning workspace with the specified parameters.

Example 2: Updates a machine learning workspace with the specified parameters by pipeline

Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlwork01 | Update-AzMLWorkspace -Tag @{'key1' = 'value2'}

Name     SystemDataCreatedAt SystemDataCreatedBy   SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastModifiedBy SystemDataLastModifiedByType Kind    Location ResourceGroupName     
----     ------------------- -------------------   ----------------------- ------------------------ ------------------------ ---------------------------- ----    -------- -----------------     
mlwork01 6/6/2024 9:40:20 AM user@example.com      User                    6/7/2024 3:57:23 AM      user@example.com         User                         Default eastus   ml-rg-test

These commands update a machine learning workspace with the specified parameters by pipeline.

Parameters

-ApplicationInsightId

ARM id of the application insights associated with this workspace.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputeRuntimeSparkRuntimeVersion

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContainerRegistryId

ARM id of the container registry associated with this workspace.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CosmoDbCollectionsThroughput

The throughput of the collections in cosmosdb database

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

The description of this workspace.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableDataIsolation

.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FeatureStoreSettingOfflineStoreConnectionName

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FeatureStoreSettingOnlineStoreConnectionName

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FriendlyName

The friendly name for this workspace.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Type:ManagedServiceIdentityType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityUserAssigned

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.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ImageBuildCompute

The compute name for image build

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IMachineLearningServicesIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-KeyVaultKeyIdentifier

.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagedNetworkIsolationMode

Isolation mode for the managed network of a machine learning workspace.

Type:IsolationMode
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManagedNetworkOutboundRule

Dictionary of <OutboundRule>

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Name of Azure Machine Learning workspace.

Type:String
Aliases:WorkspaceName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PrimaryUserAssignedIdentity

The user assigned identity resource id that represents the workspace identity.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PublicNetworkAccess

Whether requests from Public Network are allowed.

Type:PublicNetworkAccess
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ServerlessComputeSettingServerlessComputeCustomSubnet

The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuFamily

If the service has different generations of hardware, for the same SKU, then that can be captured here.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuName

The name of the SKU. Ex - P3. It is typically a letter+number code

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkuSize

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:SkuTier
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

Status for the managed network of a machine learning workspace.

Type:ManagedNetworkStatus
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StatusSparkReady

.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

The resource tags for the machine learning workspace.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-V1LegacyMode

Enabling v1_legacy_mode may prevent you from using features provided by the v2 API.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IMachineLearningServicesIdentity

Outputs

IWorkspace