Get-OCIMonitoringAlarmsList
SYNOPSIS
Invokes Monitoring service - ListAlarms operation.
SYNTAX
Limit
Get-OCIMonitoringAlarmsList -CompartmentId <String> [-OpcRequestId <String>] [-Page <String>] [-Limit <Int32>] [-DisplayName <String>] [-LifecycleState <LifecycleStateEnum>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-CompartmentIdInSubtree <Boolean>] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
AllPages
Get-OCIMonitoringAlarmsList -CompartmentId <String> [-OpcRequestId <String>] [-Page <String>] [-DisplayName <String>] [-LifecycleState <LifecycleStateEnum>] [-SortBy <SortByEnum>] [-SortOrder <SortOrderEnum>] [-CompartmentIdInSubtree <Boolean>] [-All] [-ConfigFile <String>] [-Endpoint <String>] [-NoRetry] [-Profile <String>] [-Region <String>] [-FullResponse] [-TimeOutInMillis <Int32>] [-AuthType <AuthenticationType>] [<CommonParameters>]
DESCRIPTION
Lists the alarms for the specified compartment. For more information, see Listing Alarms. For important limits information, see Limits on Monitoring. This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
PARAMETERS
-All
Fetches all pages of results.
Type: SwitchParameter
Parameter Sets: AllPages
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AuthType
Type of authentication to use for making API requests. Default is Key based Authentication.
Type: AuthenticationType
Parameter Sets: (All)
Aliases: None
Accepted values: ApiKey, InstancePrincipal, SessionToken
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CompartmentId
The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.
Example: `ocid1.compartment.oc1..exampleuniqueID`
Type: String
Parameter Sets: (All)
Aliases: None
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-CompartmentIdInSubtree
When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
Type: Boolean
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ConfigFile
The path to the config file.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisplayName
A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Endpoint
The value to use as the service endpoint, including any required API version path.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FullResponse
Output the complete response returned by the API Operation. Using this switch will make this Cmdlet output an object containing response headers in-addition to an optional response body.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-LifecycleState
A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
Type: LifecycleStateEnum
Parameter Sets: (All)
Aliases: None
Accepted values: UnknownEnumValue, Active, Deleting, Deleted
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Limit
For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.
Default: 1000
Example: 500
Type: Int32
Parameter Sets: Limit
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-NoRetry
Disable retry logic for calls to services.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OpcRequestId
Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Page
For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see List Pagination.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Profile
The profile in the config file to load.
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Region
Region-id of the region to make calls against. eg) us-phoenix-1, ap-singapore-1
Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SortBy
The field to use when sorting returned alarm definitions. Only one sorting level is provided.
Example: `severity`
Type: SortByEnum
Parameter Sets: (All)
Aliases: None
Accepted values: DisplayName, Severity
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SortOrder
The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).
Example: `ASC`
Type: SortOrderEnum
Parameter Sets: (All)
Aliases: None
Accepted values: Asc, Desc
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-TimeOutInMillis
Max wait time in milliseconds for the API request to complete. Default is 100000 millis(100 secs).
Type: Int32
Parameter Sets: (All)
Aliases: None
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.
OUTPUTS
- Oci.MonitoringService.Models.AlarmSummary
- Oci.MonitoringService.Responses.ListAlarmsResponse