Stop-AzDevCenterUserDevBox

  • Reference
Module:
Az.DevCenter

Stops a Dev Box

Syntax

Stop-AzDevCenterUserDevBox
    -Endpoint <String>
    -Name <String>
    -ProjectName <String>
    [-UserId <String>]
    [-Hibernate]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzDevCenterUserDevBox
    -Endpoint <String>
    -InputObject <IDevCenterdataIdentity>
    [-Hibernate]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzDevCenterUserDevBox
    -DevCenterName <String>
    -InputObject <IDevCenterdataIdentity>
    [-Hibernate]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzDevCenterUserDevBox
    -DevCenterName <String>
    -Name <String>
    -ProjectName <String>
    [-UserId <String>]
    [-Hibernate]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Stops a Dev Box

Examples

Example 1: Stop a dev box by endpoint

Stop-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0 -Name myDevBox

This command stops the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0".

Example 2: Stop a dev box by dev center

Stop-AzDevCenterUserDevBox -DevCenterName Contoso -ProjectName DevProject -UserId "me" -Name myDevBox

This command stops the dev box "myDevBox" assigned to the currently signed-in user.

Example 3: Stop a dev box by endpoint and InputObject

$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" }
Stop-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $devBoxInput

This command stops the dev box "myDevBox" assigned to the currently signed-in user.

Example 4: Stop a dev box by dev center and InputObject

$devBoxInput = @{"DevBoxName" = "myDevBox"; "UserId" = "786a823c-8037-48ab-89b8-8599901e67d0"; "ProjectName" = "DevProject" }
Stop-AzDevCenterUserDevBox -DevCenterName Contoso -InputObject $devBoxInput

This command stops the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0".

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

-DevCenterName

The DevCenter upon which to execute operations.

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

-Endpoint

The DevCenter-specific URI to operate on.

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

-Hibernate

Optional parameter to hibernate the dev box.

Type:SwitchParameter
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:IDevCenterdataIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of a Dev Box.

Type:String
Aliases:DevBoxName
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

-ProjectName

The DevCenter Project upon which to execute operations.

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

-UserId

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Type:String
Position:Named
Default value:"me"
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

IDevCenterdataIdentity

Outputs

Boolean