Kelverion.Azure.Monitor.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!-- Module: Kelverion.Azure.Monitor Version: 1.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-AzureKaAlert</command:name> <maml:description> <maml:para>Retrieves existing Azure alerts.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureKaAlert</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves existing Azure alerts. You can specify a TimeRange or custom time range with Start/End parameters, for retrieving alerts within that time period. If no time range is specified, a 1 day time range will be used - alerts within one day from the current time will be retrieved.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-AzureKaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more alert filters. For example: @([PSCustomObject]@{'Id'='ResourceGroup';'Operator'='EqualTo';'Value'='<resoruce group name>'}) Allowed filter fields are: AlertState AlertRule MonitorCondition MonitorService Severity SmartGroupId TargetResource TargetResourceGroup TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>Specifies the name of an alert field for sorting the results. When not specified, LastModifiedDateTime is used. Allowed values are: AlertState LastModifiedDateTime MonitorCondition Name Severity StartDateTime TargetResourceGroup TargetResourceName TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>LastModifiedDateTime</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the results sorting order, when SortBy is specified. If not specified, the results are sorted in descending order, when SortBy is a DateTime field, and in ascending order otherwise. Allowed values are: ascending descending</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>desc when SortBy is a DateTime field, asc otherwise.</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="GetById"> <!--NAME: GetById--> <maml:name>Get-AzureKaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AlertId</maml:name> <maml:description> <maml:para>Specifies the ID of an alert to be retrieved. Must be in the form /subscriptions/{subscription-guid}/providers/Microsoft.AlertsManagement/alerts/{alert-guid}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="TimeRange"> <!--NAME: TimeRange--> <maml:name>Get-AzureKaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Specifies a time range for filtering results. If not specified, a 1 day time range is used. Allowed values are: 1h 1d 7d 30d</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1d</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more alert filters. For example: @([PSCustomObject]@{'Id'='ResourceGroup';'Operator'='EqualTo';'Value'='<resoruce group name>'}) Allowed filter fields are: AlertState AlertRule MonitorCondition MonitorService Severity SmartGroupId TargetResource TargetResourceGroup TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>Specifies the name of an alert field for sorting the results. When not specified, LastModifiedDateTime is used. Allowed values are: AlertState LastModifiedDateTime MonitorCondition Name Severity StartDateTime TargetResourceGroup TargetResourceName TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>LastModifiedDateTime</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the results sorting order, when SortBy is specified. If not specified, the results are sorted in descending order, when SortBy is a DateTime field, and in ascending order otherwise. Allowed values are: ascending descending</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>desc when SortBy is a DateTime field, asc otherwise.</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="CustomTimeRange"> <!--NAME: CustomTimeRange--> <maml:name>Get-AzureKaAlert</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>Start time when specifying a custom time range for filtering results. If Start time is specified, End time must also be specified. The time interval must be within 30 days from current time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>End</maml:name> <maml:description> <maml:para>End time when specifying a custom time range for filtering results. If End time is specified, Start time must also be specified. The time interval must be within 30 days from current time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more alert filters. For example: @([PSCustomObject]@{'Id'='ResourceGroup';'Operator'='EqualTo';'Value'='<resoruce group name>'}) Allowed filter fields are: AlertState AlertRule MonitorCondition MonitorService Severity SmartGroupId TargetResource TargetResourceGroup TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>Specifies the name of an alert field for sorting the results. When not specified, LastModifiedDateTime is used. Allowed values are: AlertState LastModifiedDateTime MonitorCondition Name Severity StartDateTime TargetResourceGroup TargetResourceName TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>LastModifiedDateTime</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the results sorting order, when SortBy is specified. If not specified, the results are sorted in descending order, when SortBy is a DateTime field, and in ascending order otherwise. Allowed values are: ascending descending</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>desc when SortBy is a DateTime field, asc otherwise.</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more alert filters. For example: @([PSCustomObject]@{'Id'='ResourceGroup';'Operator'='EqualTo';'Value'='<resoruce group name>'}) Allowed filter fields are: AlertState AlertRule MonitorCondition MonitorService Severity SmartGroupId TargetResource TargetResourceGroup TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortBy</maml:name> <maml:description> <maml:para>Specifies the name of an alert field for sorting the results. When not specified, LastModifiedDateTime is used. Allowed values are: AlertState LastModifiedDateTime MonitorCondition Name Severity StartDateTime TargetResourceGroup TargetResourceName TargetResourceType</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>LastModifiedDateTime</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SortOrder</maml:name> <maml:description> <maml:para>Specifies the results sorting order, when SortBy is specified. If not specified, the results are sorted in descending order, when SortBy is a DateTime field, and in ascending order otherwise. Allowed values are: ascending descending</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>desc when SortBy is a DateTime field, asc otherwise.</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AlertId</maml:name> <maml:description> <maml:para>Specifies the ID of an alert to be retrieved. Must be in the form /subscriptions/{subscription-guid}/providers/Microsoft.AlertsManagement/alerts/{alert-guid}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeRange</maml:name> <maml:description> <maml:para>Specifies a time range for filtering results. If not specified, a 1 day time range is used. Allowed values are: 1h 1d 7d 30d</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1d</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Start</maml:name> <maml:description> <maml:para>Start time when specifying a custom time range for filtering results. If Start time is specified, End time must also be specified. The time interval must be within 30 days from current time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>End</maml:name> <maml:description> <maml:para>End time when specifying a custom time range for filtering results. If End time is specified, Start time must also be specified. The time interval must be within 30 days from current time.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-AzureKaAlertHistory</command:name> <maml:description> <maml:para>Retrieves alert history records for a specific Azure alert.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureKaAlertHistory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Retrieves alert history records for a specific Azure alert.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-AzureKaAlertHistory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AlertId</maml:name> <maml:description> <maml:para>Specifies the ID of an alert for which alert history is to be retrieved. Must be in the form /subscriptions/{subscription-guid}/providers/Microsoft.AlertsManagement/alerts/{alert-guid}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AlertId</maml:name> <maml:description> <maml:para>Specifies the ID of an alert for which alert history is to be retrieved. Must be in the form /subscriptions/{subscription-guid}/providers/Microsoft.AlertsManagement/alerts/{alert-guid}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-AzureKaAlertState</command:name> <maml:description> <maml:para>Modifies the state for a specific Azure alert.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureKaAlertState</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Modifies the state for a specific Azure alert.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-AzureKaAlertState</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AlertId</maml:name> <maml:description> <maml:para>Specifies the ID of an alert to be modified. Must be in the form /subscriptions/{subscription-guid}/providers/Microsoft.AlertsManagement/alerts/{alert-guid}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewState</maml:name> <maml:description> <maml:para>Specifies the new state of the alert. Allowed values are: Acknowledged Closed New</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>AlertId</maml:name> <maml:description> <maml:para>Specifies the ID of an alert to be modified. Must be in the form /subscriptions/{subscription-guid}/providers/Microsoft.AlertsManagement/alerts/{alert-guid}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NewState</maml:name> <maml:description> <maml:para>Specifies the new state of the alert. Allowed values are: Acknowledged Closed New</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information for the Azure subscription. For example: @{SubscriptionId='<subscription ID>';TenantId='<tenant ID>';ClientId='<client ID>';ClientSecret='<client secret>';LicenseKey='<license key>'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> </helpItems> |