Skip to content

Set-vRAProject

SYNOPSIS

Update a vRA Cloud Project

SYNTAX

ById (Default)

Set-vRAProject -Id <String> [-NewName <String>] [-Description <String>] [-Zones <PSObject[]>]
 [-Members <String[]>] [-Administrators <String[]>] [-Viewers <String[]>] [-OperationTimeout <Int32>]
 [-SharedResources <String>] [-PlacementPolicy <String>] [-CustomProperties <Hashtable>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ByName

Set-vRAProject -Name <String> [-NewName <String>] [-Description <String>] [-Zones <PSObject[]>]
 [-Members <String[]>] [-Administrators <String[]>] [-Viewers <String[]>] [-OperationTimeout <Int32>]
 [-SharedResources <String>] [-PlacementPolicy <String>] [-CustomProperties <Hashtable>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

JSON

Set-vRAProject -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update a vRA Cloud Project

EXAMPLES

EXAMPLE 1

$CloudZone = [PSCustomObject] @{

zoneId = 'e6b9d1r2d2115a7558039ae2387c' priority = 1 maxNumberInstances = 10 memoryLimitMb = 107374 }

$CustomProperties = @{} $CustomProperties.Add('Property1', "Value1") $CustomProperties.Add('Property2', "Value2")

$ProjectArguments = @{ Id = 'i84848484848484' Name = 'Test Project' Description = 'Test Project' Zones = $CloudZone Members = 'user1@test.com','user2@test.com' Administrators = 'admin1@test.com','admin2@test.com' OperationTimeout = 3600 SharedResources = 'true' CustomProperties = $CustomProperties }

Set-vRAProject @ProjectArguments

EXAMPLE 2

$JSON = @"
    {
        "id": "i8585858585858"
        "name": "Test Project",
        "description": "Test Project",
        "zones": [
            {
                "zoneId": "e6b9d1r2d2115a7558039ae2387c",
                "priority": 1,
                "maxNumberInstances": 10,
                "memoryLimitMB": 107374
            },
            {
                "zoneId": "r2d2026e33c3648334bcb67eac669",
                "priority": 2,
                "maxNumberInstances": 100,
                "memoryLimitMB": 107374
            }
        ],
        "members": [
            {
                "email": "user1@test.com"
            },
            {
                "email": "user2@test.com"
            }
        ],
        "administrators": [
            {
                "email": "admin1@test.com"
            },
            {
                "email": "admin2@test.com"
            }
        ],
        "constraints": {},
        "operationTimeout": 3600,
        "sharedResources": true
    }
"@

$JSON | Set-vRAProject

PARAMETERS

-Id

The ID of the Project to update

Type: String
Parameter Sets: ById
Aliases:

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

-Name

The Name of the Project to update

Type: String
Parameter Sets: ByName
Aliases:

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

-NewName

The Name to rename the Project to

Type: String
Parameter Sets: ById, ByName
Aliases:

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

-Description

A description of the Project

Type: String
Parameter Sets: ById, ByName
Aliases:

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

-Zones

PSCustomObject(s) with properties for a Cloud Zone

Type: PSObject[]
Parameter Sets: ById, ByName
Aliases:

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

-Members

Members to set to the Project

Type: String[]
Parameter Sets: ById, ByName
Aliases:

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

-Administrators

Administrators to set to the Project

Type: String[]
Parameter Sets: ById, ByName
Aliases:

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

-Viewers

Viewers to set to the Project

Type: String[]
Parameter Sets: ById, ByName
Aliases:

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

-OperationTimeout

Operation Timeout in seconds

Type: Int32
Parameter Sets: ById, ByName
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-SharedResources

Deployments are shared between all users in the project

Type: String
Parameter Sets: ById, ByName
Aliases:

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

-PlacementPolicy

Placement Policy - Valid values: "DEFAULT" or "SPREAD"

Type: String
Parameter Sets: ById, ByName
Aliases:

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

-CustomProperties

Specify the custom properties that should be added to all requests in this project Note the vRA API does not appear to support removing existing Custom Properties Custom Properties specifed here will be added to those already existing

Type: Hashtable
Parameter Sets: ById, ByName
Aliases:

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

-JSON

A JSON string with the body payload

Type: String
Parameter Sets: JSON
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

System.Switch

PSCustomObject

OUTPUTS

System.Management.Automation.PSObject

NOTES