Remove-AzMLWorkspace
Deletes a machine learning workspace.
Syntax
Remove-AzMLWorkspace
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Remove-AzMLWorkspace
-InputObject <IMachineLearningServicesIdentity>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-PassThru]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
Description
Deletes a machine learning workspace.
Examples
Example 1: Deletes a machine learning workspace
Remove-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-test01 -Tag @{'key1' = 'value2'}
Deletes a machine learning workspace
Example 2: Deletes a machine learning workspace by pipeline
Get-AzMLWorkspace -ResourceGroupName ml-rg-test -Name mlworkspace-test01 | Remove-AzMLWorkspace -Tag @{'key1' = 'value2'}
Deletes a machine learning workspace by pipeline
Parameters
-AsJob
Run the command as a job
Type: | SwitchParameter |
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 |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
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 |
-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 |
-PassThru
Returns true when the command succeeds
Type: | SwitchParameter |
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 |
-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 |
-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
Notes
ALIASES
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IMachineLearningServicesIdentity>
: Identity Parameter
[ComputeName <String>]
: Name of the Azure Machine Learning compute.[ConnectionName <String>]
: Friendly name of the workspace connection[DeploymentName <String>]
: Inference deployment identifier.[EndpointName <String>]
: Inference Endpoint name.[Id <String>]
: The name and identifier for the Job. This is case-sensitive.[Id1 <String>]
: Resource identity path[Location <String>]
: The location for which resource usage is queried.[Name <String>]
: Container name. This is case-sensitive.[PrivateEndpointConnectionName <String>]
: The name of the private endpoint connection associated with the workspace[ResourceGroupName <String>]
: The name of the resource group. The name is case insensitive.[SubscriptionId <String>]
: The ID of the target subscription.[Version <String>]
: Version identifier. This is case-sensitive.[WorkspaceName <String>]
: Name of Azure Machine Learning workspace.