Get-AzDevCenterUserPool

  • Reference
Module:
Az.DevCenter

Gets a pool

Syntax

Get-AzDevCenterUserPool
   -Endpoint <String>
   -ProjectName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserPool
   -Endpoint <String>
   -ProjectName <String>
   -PoolName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserPool
   -Endpoint <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserPool
   -DevCenterName <String>
   -InputObject <IDevCenterdataIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserPool
   -DevCenterName <String>
   -ProjectName <String>
   -PoolName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzDevCenterUserPool
   -DevCenterName <String>
   -ProjectName <String>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets a pool

Examples

Example 1: List pools by endpoint

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

This command lists the pools in the project "DevProject".

Example 2: List pools by dev center

Get-AzDevCenterUserPool -DevCenterName Contoso -ProjectName DevProject

This command lists the pools in the project "DevProject".

Example 3: Get pool by endpoint

Get-AzDevCenterUserPool -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -PoolName DevPool

This command gets the pool "DevPool" in the project "DevProject".

Example 4: Get pool by dev center

Get-AzDevCenterUserPool -DevCenterName Contoso -ProjectName DevProject -PoolName DevPool

This command gets the pool "DevPool" in the project "DevProject".

Example 5: Get pool by endpoint and InputObject

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

This command gets the pool "DevPool" in the project "DevProject".

Example 6: Get pool by dev center and InputObject

$devBoxInput = @{"ProjectName" = "DevProject"; "PoolName" = "DevPool" }
Get-AzDevCenterUserPool -DevCenterName Contoso -InputObject $devBoxInput

This command gets the pool "DevPool" in the project "DevProject".

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

-PoolName

The name of a pool of Dev Boxes.

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

Inputs

IDevCenterdataIdentity

Outputs

IPool