exports/New-CVRole.ps1
|
# ---------------------------------------------------------------------------------- # # Copyright Microsoft Corporation # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # ---------------------------------------------------------------------------------- <# .Synopsis Create a new role .Description Create a new role .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.ICreateRole .Outputs Commvault.Powershell.Models.IIdNameGuid .Notes COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. BODY <ICreateRole>: Create a new role. Name <String>: Name of the new role PermissionList <IPermissions[]>: Used to provide the list of permissions associated with the role. [CategoryId <Int64?>]: [CategoryName <String>]: [PermissionId <Int64?>]: [PermissionName <String>]: [Enabled <Boolean?>]: Used to determine if the role is enabled or disabled. If not provided, role will be enabled by default. [GlobalConfigInfoActionOnLocalEntity <String>]: Action that will be taken on the local entity that has the same name as the global entity that needs to be created [GlobalConfigInfoApplyOnAllCommCells <Boolean?>]: Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones [GlobalConfigInfoCommcells <IGlobalConfigCommcellInfo[]>]: List of Service CommCells where the global configuration should be applied [Guid <String>]: [Id <Int64?>]: [Name <String>]: [GlobalConfigInfoName <String>]: [GlobalConfigInfoScope <String>]: The entity level at which the config has to be applied. [GlobalConfigInfoScopeFilterQuery <String>]: CommCellEntityCache filter query string using for filtering the scope [VisibleToAll <Boolean?>]: GLOBALCONFIGINFOCOMMCELLS <IGlobalConfigCommcellInfo[]>: List of Service CommCells where the global configuration should be applied [Guid <String>]: [Id <Int64?>]: [Name <String>]: PERMISSIONLIST <IPermissions[]>: Used to provide the list of permissions associated with the role. [CategoryId <Int64?>]: [CategoryName <String>]: [PermissionId <Int64?>]: [PermissionName <String>]: .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/new-cvrole #> function New-CVRole { [OutputType([Commvault.Powershell.Models.IIdNameGuid])] [CmdletBinding(DefaultParameterSetName='New', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='New', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.ICreateRole] # Create a new role. # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='NewExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [System.String] # Name of the new role ${Name}, [Parameter(ParameterSetName='NewExpanded', Mandatory)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IPermissions[]] # Used to provide the list of permissions associated with the role. # To construct, see NOTES section for PERMISSIONLIST properties and create a hash table. ${PermissionList}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Used to determine if the role is enabled or disabled. # If not provided, role will be enabled by default. ${Enabled}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Action that will be taken on the local entity that has the same name as the global entity that needs to be created ${GlobalConfigInfoActionOnLocalEntity}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones ${GlobalConfigInfoApplyOnAllCommCells}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IGlobalConfigCommcellInfo[]] # List of Service CommCells where the global configuration should be applied # To construct, see NOTES section for GLOBALCONFIGINFOCOMMCELLS properties and create a hash table. ${GlobalConfigInfoCommcells}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${GlobalConfigInfoName}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # The entity level at which the config has to be applied. ${GlobalConfigInfoScope}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # CommCellEntityCache filter query string using for filtering the scope ${GlobalConfigInfoScopeFilterQuery}, [Parameter(ParameterSetName='NewExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${VisibleToAll}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [Commvault.Powershell.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Returns true when the command succeeds ${PassThru}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [Commvault.Powershell.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ New = 'CommvaultPowershell.private\New-CVRole_New'; NewExpanded = 'CommvaultPowershell.private\New-CVRole_NewExpanded'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |