Invoke-AzDevCenterUserDelayEnvironmentAction

  • Reference
Module:
Az.DevCenter

Delays the occurrence of an action.

Syntax

Invoke-AzDevCenterUserDelayEnvironmentAction
      -Endpoint <String>
      -Name <String>
      -EnvironmentName <String>
      -ProjectName <String>
      [-UserId <String>]
      -DelayTime <TimeSpan>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzDevCenterUserDelayEnvironmentAction
      -DevCenterName <String>
      -Name <String>
      -EnvironmentName <String>
      -ProjectName <String>
      [-UserId <String>]
      -DelayTime <TimeSpan>
      [-DefaultProfile <PSObject>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Delays the occurrence of an action.

Examples

Example 1: Delay an action on the environment by endpoint

Invoke-AzDevCenterUserDelayEnvironmentAction -Endpoint "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/" -EnvironmentName myEnvironment -ProjectName DevProject -Name "myEnvironment-Delete" -DelayTime "00:30"

This command delays the action "schedule-default" for the environment "myEnvironment" for 30 minutes.

Example 2: Delay an action on the environment by dev center

Invoke-AzDevCenterUserDelayEnvironmentAction -DevCenterName Contoso -EnvironmentName myEnvironment -UserId "me" -ProjectName DevProject -Name "myEnvironment-Delete" -DelayTime "05:15"

This command delays the action "myEnvironment-Delete" for the environment "myEnvironment" for 5 hours and 15 minutes.

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

-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

-DelayTime

The delayed timespan from the scheduled action time. Format HH:MM.

Type:TimeSpan
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

-EnvironmentName

The name of the environment.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

The name of an action that will take place on an Environment.

Type:String
Aliases:ActionName
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

-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

IEnvironmentAction