New-AzDevCenterUserDevBox

  • Reference
Module:
Az.DevCenter

Creates or replaces a Dev Box.

Syntax

New-AzDevCenterUserDevBox
   -Endpoint <String>
   -Name <String>
   -ProjectName <String>
   [-UserId <String>]
   -PoolName <String>
   [-LocalAdministrator <LocalAdminStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDevCenterUserDevBox
   -Endpoint <String>
   -InputObject <IDevCenterdataIdentity>
   -PoolName <String>
   [-LocalAdministrator <LocalAdminStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDevCenterUserDevBox
   -DevCenterName <String>
   -InputObject <IDevCenterdataIdentity>
   -PoolName <String>
   [-LocalAdministrator <LocalAdminStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDevCenterUserDevBox
   -DevCenterName <String>
   -Name <String>
   -ProjectName <String>
   [-UserId <String>]
   -PoolName <String>
   [-LocalAdministrator <LocalAdminStatus>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates or replaces a Dev Box.

Examples

Example 1: Create a dev box by endpoint

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

This command creates the dev box "myDevBox" for the user "786a823c-8037-48ab-89b8-8599901e67d0".

Example 2: Create a dev box by dev center

New-AzDevCenterUserDevBox -DevCenterName Contoso -ProjectName DevProject -UserId "me" -Name myDevBox -PoolName DevPool

This command creates the dev box "myDevBox" for the currently signed-in user.

Example 3: Create a dev box by endpoint and InputObject

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

This command creates the dev box "myDevBox" for the currently signed-in user.

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

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

This command creates the dev box "myDevBox" for the 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

-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

-LocalAdministrator

Indicates whether the owner of the Dev Box is a local administrator.

Type:LocalAdminStatus
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-PoolName

The name of the Dev Box pool this machine belongs to.

Type:String
Position:Named
Default value:None
Required:True
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

IDevBox