Set-vRATenant

NAME Set-vRATenant



SYNOPSIS

Update a vRA Tenant





SYNTAX

Set-vRATenant -Name <String> [-Description <String>] [-ContactEmail <String>] -ID <String> [-WhatIf] [-Confirm]

[<CommonParameters>]



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





DESCRIPTION

Update a vRA Tenant





PARAMETERS

-Name <String>

Tenant Name



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

Tenant Description



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ContactEmail <String>

Tenant Contact Email



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ID <String>

Tenant ID



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-JSON <String>

Body text to send in JSON format



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String.





OUTPUTS

System.Management.Automation.PSObject





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-vRATenant -Name Tenant01 -Description "This is the updated description" -ID Tenant01













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$JSON = @"



{

"name" : "Tenant02",

"description" : "This is the updated description for Tenant02",

"urlName" : "Tenant02",

"contactEmail" : "test.user@tenant02.local",

"id" : "Tenant02",

"defaultTenant" : false,

"password" : ""

}

"@

$JSON | Set-vRATenant











RELATED LINKS