Edit

Share via

New-AzDevCenterUserDevBoxCustomizationGroup

  • Reference
Module:
Az.DevCenter

Applies customizations to the Dev Box.

Syntax

New-AzDevCenterUserDevBoxCustomizationGroup
   -Endpoint <String>
   -CustomizationGroupName <String>
   -DevBoxName <String>
   -ProjectName <String>
   [-UserId <String>]
   [-Task <ICustomizationTask[]>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDevCenterUserDevBoxCustomizationGroup
   -Endpoint <String>
   -InputObject <IDevCenterdataIdentity>
   [-Task <ICustomizationTask[]>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDevCenterUserDevBoxCustomizationGroup
   -DevCenterName <String>
   -InputObject <IDevCenterdataIdentity>
   [-Task <ICustomizationTask[]>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-AzDevCenterUserDevBoxCustomizationGroup
   -DevCenterName <String>
   -CustomizationGroupName <String>
   -DevBoxName <String>
   -ProjectName <String>
   [-UserId <String>]
   [-Task <ICustomizationTask[]>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Applies customizations to the Dev Box.

Examples

Example 1: Create a customization groupby endpoint

$task = @{
    Name = "catalogName/choco"
    DisplayName = "choco"
    Parameter = @{
        PackageName = "vscode"
        PackageVersion = "1.0.0"
    }
    RunAs = "System"
    TimeoutInSecond = 120
}
$tasks = @($task)
New-AzDevCenterUserDevBoxCustomizationGroup -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -UserId 00aa00aa-bb11-cc22-dd33-44ee44ee44ee -DevBoxName myDevBox -CustomizationGroupName Provisioning -Task $tasks

This command creates the customization group "Provisoning" for the dev box "myDevBox".

Example 2: Create a customization groupby dev center

New-AzDevCenterUserDevBoxCustomizationGroup -DevCenterName Contoso -ProjectName DevProject -UserId "me" -DevBoxName myDevBox -CustomizationGroupName Provisioning -Task $tasks

This command creates the customization group "Provisoning" for the dev box "myDevBox".

Example 3: Create a customization groupby endpoint and InputObject

$customizationGroupInput = @{"CustomizationGroupName" = "Provisioning"; "DevBoxName" = "myDevBox"; "UserId" = "me"; "ProjectName" = "DevProject" }
New-AzDevCenterUserDevBoxCustomizationGroup -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $customizationGroupInput -Task $tasks

This command creates the customization group "Provisoning" for the dev box "myDevBox".

Example 4: Create a customization groupby dev center and InputObject

$customizationGroupInput = @{"CustomizationGroupName" = "Provisioning"; "DevBoxName" = "myDevBox"; "UserId" = "00aa00aa-bb11-cc22-dd33-44ee44ee44ee"; "ProjectName" = "DevProject" }
New-AzDevCenterUserDevBoxCustomizationGroup -DevCenterName Contoso -InputObject $customizationGroupInput -Task $tasks

This command creates the customization group "Provisoning" for the dev box "myDevBox".

Parameters

-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

-CustomizationGroupName

A customization group name.

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

-DevBoxName

The name of a Dev Box.

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

-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

-Task

Tasks to apply. Note by default tasks are excluded from the response whenlisting customization groups. To include them, use the include=tasks queryparameter. To construct, see NOTES section for TASK properties and create a hash table.

Type:ICustomizationTask[]
Position:Named
Default value:None
Required:False
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

ICustomizationGroup