Edit

Share via

Get-AzDevCenterUserDevBoxCustomizationTaskDefinition

Module:
Az.DevCenter Module

Gets a customization task.

Syntax

List (Default) 

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

Get 

Get-AzDevCenterUserDevBoxCustomizationTaskDefinition
    -Endpoint <String>
    -ProjectName <String>
    -CatalogName <String>
    -TaskName <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

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

GetViaIdentityByDevCenter 

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

ListByDevCenter 

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

GetByDevCenter 

Get-AzDevCenterUserDevBoxCustomizationTaskDefinition
    -DevCenterName <String>
    -ProjectName <String>
    -CatalogName <String>
    -TaskName <String>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets a customization task.

Examples

Example 1: List customization tasks by endpoint

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

This command lists customization tasks in the project "DevProject".

Example 2: List customization tasks by dev center

Get-AzDevCenterUserDevBoxCustomizationTaskDefinition -DevCenterName Contoso -ProjectName DevProject

This command lists customization tasks in the project "DevProject".

Example 3: Get a customization task by endpoint

Get-AzDevCenterUserDevBoxCustomizationTaskDefinition -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -ProjectName DevProject -TaskName choco -CatalogName MyCatalog

This command gets a customization task named "choco" for the catalog "MyCatalog" in the project "DevProject".

Example 4: Get a customization task by dev center

Get-AzDevCenterUserDevBoxCustomizationTaskDefinition -DevCenterName Contoso -ProjectName DevProject -TaskName choco -CatalogName MyCatalog

This command gets a customization task named "choco" for the catalog "MyCatalog" in the project "DevProject".

Example 5: Get a customization task by endpoint and InputObject

$customizationTaskInput = @{"TaskName" = "choco"; "ProjectName" ="DevProject"; "CatalogName" = "MyCatalog" }
Get-AzDevCenterUserDevBoxCustomizationTaskDefinition -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $customizationTaskInput

This command gets a customization task named "choco" for the catalog "MyCatalog" in the project "DevProject".

Example 6: Get a customization task by dev center and InputObject

$customizationTaskInput = @{"TaskName" = "choco"; "ProjectName" = "DevProject"; "CatalogName" = "MyCatalog" }
Get-AzDevCenterUserDevBoxCustomizationTaskDefinition -DevCenterName Contoso -InputObject $customizationTaskInput

This command gets a customization task named "choco" for the catalog "MyCatalog" in the project "DevProject".

Parameters

-CatalogName

Name of the catalog.

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
GetByDevCenter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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
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

-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

-ProjectName

Name of the project.

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
ListByDevCenter
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

-TaskName

Full name of the task: {catalogName}/{taskName}.

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
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

ICustomizationTaskDefinition