Get-AzDevCenterAdminDevBoxDefinition
Gets a Dev Box definition
Syntax
Get-AzDevCenterAdminDevBoxDefinition
-DevCenterName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDevCenterAdminDevBoxDefinition
-DevCenterName <String>
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDevCenterAdminDevBoxDefinition
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-ProjectName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDevCenterAdminDevBoxDefinition
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-ProjectName <String>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDevCenterAdminDevBoxDefinition
-InputObject <IDevCenterIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Gets a Dev Box definition
Examples
Example 1: List dev box definitions in a dev center
Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -DevCenterName ContosoThis command lists the dev box definitions in the dev center "Contoso" under the resource group "testRg".
Example 2: List dev box definitions in a project
Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -ProjectName DevProjectThis command lists the dev box definitions in the project "DevProject" under the resource group "testRg".
Example 3: Get a dev center dev box definition
Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -DevCenterName Contoso -Name WebDevBoxDefThis command gets the dev box definition "WebDevBoxDef" in the dev center "Contoso" under the resource group "testRg".
Example 4: Get a project dev box definition
Get-AzDevCenterAdminDevBoxDefinition -ResourceGroupName testRg -ProjectName DevProject -Name WebDevBoxDefThis command gets the dev box definition "WebDevBoxDef" in the project "DevProject" under the resource group "testRg".
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 name of the devcenter.
| 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: | IDevCenterIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the Dev Box definition.
| Type: | String |
| Aliases: | DevBoxDefinitionName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProjectName
The name of the project.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |