Edit

Share via


Get-AzDevCenterUserEnvironmentAction

Retrieve a specific environment action.

Syntax

List (Default)

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

Get

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

GetViaIdentity

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

GetViaIdentityByDevCenter

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

ListByDevCenter

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

GetByDevCenter

Get-AzDevCenterUserEnvironmentAction
    -DevCenterName <String>
    -EnvironmentName <String>
    -ProjectName <String>
    -Name <String>
    [-UserId <String>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Retrieve a specific environment action.

Examples

Example 1: List actions on the environment by endpoint

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

This command lists the actions on the environment "myEnvironment".

Example 2: List actions on the environment by dev center

Get-AzDevCenterUserEnvironmentAction -DevCenterName Contoso -EnvironmentName myEnvironment -ProjectName DevProject

This command lists the actions on the environment "myEnvironment".

Example 3: Get an action on the environment by endpoint

Get-AzDevCenterUserEnvironmentAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -EnvironmentName myEnvironment -ProjectName DevProject -Name "myEnvironment-Delete"

This command gets the action "myEnvironment-Delete" for the environment "myEnvironment".

Example 4: Get an action on the environment by dev center

Get-AzDevCenterUserEnvironmentAction -DevCenterName Contoso -EnvironmentName myEnvironment -ProjectName DevProject -Name "myEnvironment-Delete"

This command gets the action "myEnvironment-Delete" for the environment "myEnvironment".

Example 5: Get an action on the environment by endpoint and InputObject

$environmentInput = @{"EnvironmentName" = "myEnvironment"; "UserId" = "me"; "ProjectName" = "DevProject"; "ActionName" = "myEnvironment-Delete"}
Get-AzDevCenterUserEnvironmentAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -InputObject $environmentInput

This command gets the action "myEnvironment-Delete" for the environment "myEnvironment".

Example 6: Get an action on the environment by dev center and InputObject

$environmentInput = @{"EnvironmentName" = "myEnvironment"; "UserId" = "me"; "ProjectName" = "DevProject"; "ActionName" = "myEnvironment-Delete"}
Get-AzDevCenterUserEnvironmentAction -DevCenterName Contoso -InputObject $environmentInput

This command gets the action "myEnvironment-Delete" for the environment "myEnvironment".

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

-EnvironmentName

Environment name.

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

-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

Uniquely identifies the action.

Parameter properties

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

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

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

-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:me
Supports wildcards:False
DontShow:False

Parameter sets

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

IEnvironmentAction