Edit

Share via

Get-AzDevCenterUserDevBox

Module:
Az.DevCenter Module

Gets a Dev Box.

Syntax

List (Default) 

Get-AzDevCenterUserDevBox
    -Endpoint <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

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

GetViaIdentity 

Get-AzDevCenterUserDevBox
    -Endpoint <String>
    -InputObject <IDevCenterdataIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1 

Get-AzDevCenterUserDevBox
    -Endpoint <String>
    -UserId <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List2 

Get-AzDevCenterUserDevBox
    -Endpoint <String>
    -ProjectName <String>
    -UserId <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityByDevCenter 

Get-AzDevCenterUserDevBox
    -DevCenterName <String>
    -InputObject <IDevCenterdataIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ListByDevCenter 

Get-AzDevCenterUserDevBox
    -DevCenterName <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List2ByDevCenter 

Get-AzDevCenterUserDevBox
    -DevCenterName <String>
    -ProjectName <String>
    -UserId <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

List1ByDevCenter 

Get-AzDevCenterUserDevBox
    -DevCenterName <String>
    -UserId <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetByDevCenter 

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.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DevCenterName

The DevCenter upon which to execute operations.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DevCenter

Parameter sets

GetViaIdentityByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ListByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2ByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1ByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Endpoint

The DevCenter-specific URI to operate on.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

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

Parameter properties

Type:IDevCenterdataIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
GetViaIdentityByDevCenter
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Display name for the Dev Box.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DevBoxName

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProjectName

Name of the project.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2ByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2ByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1ByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IDevCenterdataIdentity

Outputs

IDevBox