exports/Edit-CVAlertDefinition.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 Edit Alert Definition details .Description Edit Alert Definition details .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Inputs Commvault.Powershell.Models.IAlertDefinitionsEdit .Inputs Commvault.Powershell.Models.ICommvaultPowerShellIdentity .Outputs Commvault.Powershell.Models.IGenericResp .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. ASSOCIATIONS <IAlertAssociationIdNameType1[]>: AlertDefinitionsAssociations [Id <Int64?>]: id of the associated entity [Name <String>]: name of the associated entity [ParentEntity1Id <Int64?>]: id of the associated entity [ParentEntity1Name <String>]: name of the associated entity [ParentEntity1Type <String>]: [ParentEntity2Id <Int64?>]: id of the associated entity [ParentEntity2Name <String>]: name of the associated entity [ParentEntity2Type <String>]: [ParentEntity3Id <Int64?>]: id of the associated entity [ParentEntity3Name <String>]: name of the associated entity [ParentEntity3Type <String>]: [ParentEntity4Id <Int64?>]: id of the associated entity [ParentEntity4Name <String>]: name of the associated entity [ParentEntity4Type <String>]: [Type <String>]: BODY <IAlertDefinitionsEdit>: AlertDefinitionsEdit [AlertTargetRecipientsOperationType <String>]: Allows adding to, overwriting and deleting existing recipients. default is adding to existing recipients [AlertTargetSendAlertTo <String[]>]: [Associations <IAlertAssociationIdNameType1[]>]: AlertDefinitionsAssociations [Id <Int64?>]: id of the associated entity [Name <String>]: name of the associated entity [ParentEntity1Id <Int64?>]: id of the associated entity [ParentEntity1Name <String>]: name of the associated entity [ParentEntity1Type <String>]: [ParentEntity2Id <Int64?>]: id of the associated entity [ParentEntity2Name <String>]: name of the associated entity [ParentEntity2Type <String>]: [ParentEntity3Id <Int64?>]: id of the associated entity [ParentEntity3Name <String>]: name of the associated entity [ParentEntity3Type <String>]: [ParentEntity4Id <Int64?>]: id of the associated entity [ParentEntity4Name <String>]: name of the associated entity [ParentEntity4Type <String>]: [Type <String>]: [AssociationsOperationType <String>]: Allows adding to, overwriting and deleting existing alert associations. default is adding to existing alert associations [LocaleId <Int64?>]: [LocaleName <String>]: [NewName <String>]: The new name of the alert definition [RecipientBcc <IAlertTargetIdNameType1[]>]: [Id <Int64?>]: [Name <String>]: [Type <String>]: [RecipientCc <IAlertTargetIdNameType1[]>]: [RecipientTo <IAlertTargetIdNameType1[]>]: [RecipientWebHookId <Int64?>]: id of the webhook to be associated with the alert definition. Only needed incase of webhook notif selected. To get a list of webhooks, use api GET Webhook [SendIndividualNotifications <Boolean?>]: [SubscriptionBasedAlert <Boolean?>]: Flag to indicate whether its a subscription based alert. [TemplateConsole <String>]: the message template for the console notification [TemplateEmail <String>]: the message template for the email notification. Contains both email subject as well as body [TemplateEventViewer <String>]: the message template for the event viewer notification [TemplateWebhook <String>]: the message template for the webhook notification [TokenMatch <String>]: [TokenRuleGroups <ITokenRuleGroup[]>]: List of rule groups [Match <String>]: [Rules <ITokenRule[]>]: List of rules [DateRangeFromDate <String>]: From date value in unix timestamp format [DateRangeTimeRange <ITimeRange[]>]: Time range selection details [FromTime <String>]: From time value in unix timestamp format [ToTime <String>]: To time value in unix timestamp format [DateRangeToDate <String>]: To date value in unix timestamp format [MatchCondition <String>]: [RuleSecValue <String>]: Secondary value used for BETWEEN and NOT_BETWEEN matchCondition. [TimeRangeFromTime <String>]: From time value in unix timestamp format [TimeRangeToTime <String>]: To time value in unix timestamp format [TokenFormat <String>]: [TokenName <String>]: Name of the token. [Value <String>]: Value to be compared for the token INPUTOBJECT <ICommvaultPowerShellIdentity>: Identity Parameter [AccessPathId <Int64?>]: Id of the mount path whose access path has to be deleted [AgentId <Int64?>]: Id of the agent to be modified [AppGuid <String>]: GUID of the Application to get details [AppId <Int64?>]: Commvault exchange app id [ApplicationGroupId <Int64?>]: applicationGroupId is the ID of the Kubernetes application group [ArrayId <Int64?>]: [AssetId <String>]: FQDN of the asset [BackupDestinationId <Int64?>]: Id of the backupDestination to be modified [BackupDestionationId <Int64?>]: [BackupLocationId <Int64?>]: Id of the backup location whose details have to be fetched [BlackoutWindowId <Int64?>]: Id of the Blackout Window whose details have to be fetched [BucketId <Int64?>]: Id of Bucket [ClientId <Int64?>]: [CloneId <Int64?>]: ID of the cloned bucket [CloudStorageId <Int64?>]: Id of cloud Storage [ClusterId <Int64?>]: Id of the cluster whose modifier has to be listed. [CompanyId <Int64?>]: Id of the Company whose details have to be fetched [CopyId <Int64?>]: [CredentialId <String>]: [CredentialName <String>]: [DomainId <Int64?>]: ID of the AD/LDAP domain [DrOperation <String>]: Name of DR operation. Case insensitive [DriveId <Int64?>]: Id of the Drive of which the drive details has to be displayed [EntityId <Int64?>]: Recovery entity Id [EntityType <String>]: Type of the entity [FailoverGroupId <Int64?>]: Id of the failover group [GlobalSearchEntity <String>]: name of global search entity [HfsShareId <Int64?>]: Id of the HFS Share to fetch its status [HyperScaleStorageId <Int64?>]: Id of hyperscale storage [HypervisorId <Int64?>]: Id of the HYpervisor to get [Id <Int64?>]: [IndexServerClientId <Int64?>]: Pseudo client id of the index server [InstanceId <Int64?>]: Id of the instance to modify [InventoryId <Int64?>]: Inventory id [JobId <Int64?>]: [KmsId <Int64?>]: Id of Key Management Server [LibraryId <Int64?>]: Id of the library to view the data [MediaAgentId <Int64?>]: Id of the Media Agent whose details have to be fetched [MetadataCacheId <Int64?>]: Id of metadata cache [ModifierName <String>]: Name of the modifier to be read. [Name <String>]: [NameSpace <String>]: Name of the namespace to browse for content [NodeId <Int64?>]: Id of node [PairId <Int64?>]: [PlanId <Int64?>]: Id of the object store plan to fetch details [RecoveryGroupId <Int64?>]: Recovery group Id [RecoveryTargetId <Int64?>]: id of recovery target [RegionId <Int64?>]: Region id to be deleted. [RegionList <String>]: List of region names/ids to be deleted. If region ids are passed, set isRegionIdList=true [ReplicationGroupId <Int64?>]: [RequestId <Int64?>]: Unique identifier for the request [RoleId <Int64?>]: Role Id [RpsId <String>]: [RuleId <Int64?>]: Id of the rule to update in Plan [ScheduleId <Int64?>]: ID of the DR operation schedule [SchedulePolicyId <Int64?>]: [ServerGroupId <Int64?>]: Id of the serverGroupId whose details have to be fetched [ServerId <Int64?>]: Id of the server to modify [StoragePoolId <Int64?>]: Id of the storage pool whose associated copies have to be fetched [SubclientId <Int64?>]: Id of the subclient to modify [TagId <Int64?>]: Id of the tag to delete [TagValue <String>]: tag value to delete [TopologyId <String>]: [UserGroupId <Int64?>]: Id of the user-group whose details have to be fetched [UserId <Int64?>]: Id of the User whose details have to be fetched [VMGroupId <Int64?>]: Id of the VMgroup to update [VMGuid <String>]: [VMUuid <String>]: The vmUUID can be obtained from GET /virtualMachines UUID property [VendorId <Int64?>]: RECIPIENTBCC <IAlertTargetIdNameType1[]>: . [Id <Int64?>]: [Name <String>]: [Type <String>]: RECIPIENTCC <IAlertTargetIdNameType1[]>: . [Id <Int64?>]: [Name <String>]: [Type <String>]: RECIPIENTTO <IAlertTargetIdNameType1[]>: . [Id <Int64?>]: [Name <String>]: [Type <String>]: TOKENRULEGROUPS <ITokenRuleGroup[]>: List of rule groups [Match <String>]: [Rules <ITokenRule[]>]: List of rules [DateRangeFromDate <String>]: From date value in unix timestamp format [DateRangeTimeRange <ITimeRange[]>]: Time range selection details [FromTime <String>]: From time value in unix timestamp format [ToTime <String>]: To time value in unix timestamp format [DateRangeToDate <String>]: To date value in unix timestamp format [MatchCondition <String>]: [RuleSecValue <String>]: Secondary value used for BETWEEN and NOT_BETWEEN matchCondition. [TimeRangeFromTime <String>]: From time value in unix timestamp format [TimeRangeToTime <String>]: To time value in unix timestamp format [TokenFormat <String>]: [TokenName <String>]: Name of the token. [Value <String>]: Value to be compared for the token .Link https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/edit-cvalertdefinition #> function Edit-CVAlertDefinition { [OutputType([Commvault.Powershell.Models.IGenericResp])] [CmdletBinding(DefaultParameterSetName='EditExpanded', PositionalBinding=$false, SupportsShouldProcess, ConfirmImpact='Medium')] param( [Parameter(ParameterSetName='Edit', Mandatory)] [Parameter(ParameterSetName='EditExpanded', Mandatory)] [Commvault.Powershell.Category('Path')] [System.Int64] # . ${Id}, [Parameter(ParameterSetName='EditViaIdentity', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='EditViaIdentityExpanded', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Path')] [Commvault.Powershell.Models.ICommvaultPowerShellIdentity] # Identity Parameter # To construct, see NOTES section for INPUTOBJECT properties and create a hash table. ${InputObject}, [Parameter(ParameterSetName='Edit', Mandatory, ValueFromPipeline)] [Parameter(ParameterSetName='EditViaIdentity', Mandatory, ValueFromPipeline)] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IAlertDefinitionsEdit] # AlertDefinitionsEdit # To construct, see NOTES section for BODY properties and create a hash table. ${Body}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Allows adding to, overwriting and deleting existing recipients. # default is adding to existing recipients ${AlertTargetRecipientsOperationType}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String[]] # . ${AlertTargetSendAlertTo}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IAlertAssociationIdNameType1[]] # AlertDefinitionsAssociations # To construct, see NOTES section for ASSOCIATIONS properties and create a hash table. ${Associations}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # Allows adding to, overwriting and deleting existing alert associations. # default is adding to existing alert associations ${AssociationsOperationType}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # . ${LocaleId}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${LocaleName}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # The new name of the alert definition ${NewName}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IAlertTargetIdNameType1[]] # . # To construct, see NOTES section for RECIPIENTBCC properties and create a hash table. ${RecipientBcc}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IAlertTargetIdNameType1[]] # . # To construct, see NOTES section for RECIPIENTCC properties and create a hash table. ${RecipientCc}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.IAlertTargetIdNameType1[]] # . # To construct, see NOTES section for RECIPIENTTO properties and create a hash table. ${RecipientTo}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Int64] # id of the webhook to be associated with the alert definition. # Only needed incase of webhook notif selected. # To get a list of webhooks, use api GET Webhook ${RecipientWebHookId}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # . ${SendIndividualNotifications}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.Management.Automation.SwitchParameter] # Flag to indicate whether its a subscription based alert. ${SubscriptionBasedAlert}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # the message template for the console notification ${TemplateConsole}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # the message template for the email notification. # Contains both email subject as well as body ${TemplateEmail}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # the message template for the event viewer notification ${TemplateEventViewer}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # the message template for the webhook notification ${TemplateWebhook}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [System.String] # . ${TokenMatch}, [Parameter(ParameterSetName='EditExpanded')] [Parameter(ParameterSetName='EditViaIdentityExpanded')] [Commvault.Powershell.Category('Body')] [Commvault.Powershell.Models.ITokenRuleGroup[]] # List of rule groups # To construct, see NOTES section for TOKENRULEGROUPS properties and create a hash table. ${TokenRuleGroups}, [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 = @{ Edit = 'CommvaultPowershell.private\Edit-CVAlertDefinition_Edit'; EditExpanded = 'CommvaultPowershell.private\Edit-CVAlertDefinition_EditExpanded'; EditViaIdentity = 'CommvaultPowershell.private\Edit-CVAlertDefinition_EditViaIdentity'; EditViaIdentityExpanded = 'CommvaultPowershell.private\Edit-CVAlertDefinition_EditViaIdentityExpanded'; } $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 } } } |