Get-AzDevCenterUserDevBox

  • Reference
Module:
Az.DevCenter

Gets a Dev Box

Syntax

Get-AzDevCenterUserDevBox
   -Endpoint <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -Endpoint <String>
   -ProjectName <String>
   -UserId <String>
   -Name <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -Endpoint <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -Endpoint <String>
   -UserId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -Endpoint <String>
   -ProjectName <String>
   -UserId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -DevCenterName <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -DevCenterName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -DevCenterName <String>
   -ProjectName <String>
   -UserId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -DevCenterName <String>
   -UserId <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserDevBox
   -DevCenterName <String>
   -ProjectName <String>
   -UserId <String>
   -Name <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a Dev Box

Examples

Example 1: List dev boxes by endpoint

Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/"

This command lists dev boxes under the endpoint.

Example 2: List dev boxes by endpoint and user id

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

This command lists dev boxes under the endpoint assigned to user "786a823c-8037-48ab-89b8-8599901e67d0".

Example 3: List dev boxes by endpoint, user id, and project

Get-AzDevCenterUserDevBox -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId "me"

This command lists dev boxes under the project "DevProject" assigned to the currently signed-in user.

Example 4: List dev boxes by dev center name

Get-AzDevCenterUserDevBox -DevCenterName Contoso

This command lists dev boxes under the dev center "Contoso".

Example 5: List dev boxes by dev center and user id

Get-AzDevCenterUserDevBox -DevCenterName Contoso -UserId "me"

This command lists dev boxes under the dev center "Contoso" assigned to the currently signed-in user.

Example 6: List dev boxes by dev center, user id, and project

Get-AzDevCenterUserDevBox -DevCenterName Contoso -ProjectName DevProject -UserId 786a823c-8037-48ab-89b8-8599901e67d0

This command lists dev boxes under the project "DevProject" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0".

Example 7: Get a dev box by endpoint

Get-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 gets the dev box "myDevBox" assigned to user "786a823c-8037-48ab-89b8-8599901e67d0".

Example 8: Get a dev box by dev center

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

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

Example 9: Get a dev box by endpoint and InputObject

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

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

Example 10: Get a dev box by dev center and InputObject

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

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

Parameters

-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

-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

-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:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IDevCenterdataIdentity

Outputs

IDevBox