Update-AzDevCenterAdminPool

Reference

Module:: Az.DevCenter

Partially updates a machine pool

Syntax

Update-AzDevCenterAdminPool
      -Name <String>
      -ProjectName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DevBoxDefinitionName <String>]
      [-DisplayName <String>]
      [-LocalAdministrator <LocalAdminStatus>]
      [-ManagedVirtualNetworkRegion <String[]>]
      [-NetworkConnectionName <String>]
      [-SingleSignOnStatus <SingleSignOnStatus>]
      [-StopOnDisconnectGracePeriodMinute <Int32>]
      [-StopOnDisconnectStatus <StopOnDisconnectEnableStatus>]
      [-Tag <Hashtable>]
      [-VirtualNetworkType <VirtualNetworkType>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDevCenterAdminPool
      -InputObject <IDevCenterIdentity>
      [-DevBoxDefinitionName <String>]
      [-DisplayName <String>]
      [-LocalAdministrator <LocalAdminStatus>]
      [-ManagedVirtualNetworkRegion <String[]>]
      [-NetworkConnectionName <String>]
      [-SingleSignOnStatus <SingleSignOnStatus>]
      [-StopOnDisconnectGracePeriodMinute <Int32>]
      [-StopOnDisconnectStatus <StopOnDisconnectEnableStatus>]
      [-Tag <Hashtable>]
      [-VirtualNetworkType <VirtualNetworkType>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Partially updates a machine pool

Examples

Example 1: Update a pool

Update-AzDevCenterAdminPool -Name DevPool -ProjectName DevProject -ResourceGroupName testRg -DevBoxDefinitionName WebDevBox -LocalAdministrator "Disabled" -NetworkConnectionName Network1westus2

This command updates a pool named "DevPool" in the project "DevProject".

Example 2: Update a pool using InputObject

Get-AzDevCenterAdminPool -ResourceGroupName testRg -Name DevPool -ProjectName DevProject
Update-AzDevCenterAdminPool -InputObject $poolInput -DevBoxDefinitionName WebDevBox -LocalAdministrator "Disabled" -NetworkConnectionName Network1westus2

This command updates a pool named "DevPool" in the project "DevProject".

Parameters

-AsJob

Run the command as a job

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

-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

-DevBoxDefinitionName

Name of a Dev Box definition in parent Project of this Pool

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

-DisplayName

The display name of the pool.

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

-LocalAdministrator

Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.

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

-ManagedVirtualNetworkRegion

The regions of the managed virtual network (required when managedNetworkType is Managed).

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

-Name

Name of the pool.

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

-NetworkConnectionName

Name of a Network Connection in parent Project of this Pool

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

-NoWait

Run the command asynchronously

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

-SingleSignOnStatus

Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.

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

-StopOnDisconnectGracePeriodMinute

The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.

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

-StopOnDisconnectStatus

Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.

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

-Tag

Resource tags.

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

-VirtualNetworkType

Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.

Type:	VirtualNetworkType
Position:	Named
Default value:	None
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

IDevCenterIdentity

Outputs

IPool

Share via