Class MonitoringClient
Service client instance for Monitoring.
Implements
Inherited Members
Namespace: Oci.MonitoringService
Assembly: OCI.DotNetSDK.Monitoring.dll
Syntax
public class MonitoringClient : RegionalClientBase, IDisposable
Constructors
MonitoringClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public MonitoringClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public MonitoringPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
MonitoringPaginators |
Waiters
Declaration
public MonitoringWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
MonitoringWaiters |
Methods
ChangeAlarmCompartment(ChangeAlarmCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves an alarm into a different compartment within the same tenancy. For more information, see Moving an Alarm.
Declaration
public Task<ChangeAlarmCompartmentResponse> ChangeAlarmCompartment(ChangeAlarmCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeAlarmCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeAlarmCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeAlarmCompartment API.
CreateAlarm(CreateAlarmRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new alarm in the specified compartment. For more information, see Creating an Alarm. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<CreateAlarmResponse> CreateAlarm(CreateAlarmRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAlarmRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAlarmResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAlarm API.
CreateAlarmSuppression(CreateAlarmSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific). For more information, see Adding an Alarm-wide Suppression and Adding a Dimension-Specific Alarm Suppression. <br/> For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<CreateAlarmSuppressionResponse> CreateAlarmSuppression(CreateAlarmSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAlarmSuppressionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAlarmSuppressionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAlarmSuppression API.
DeleteAlarm(DeleteAlarmRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified alarm. For more information, see Deleting an Alarm. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<DeleteAlarmResponse> DeleteAlarm(DeleteAlarmRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAlarmRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAlarmResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAlarm API.
DeleteAlarmSuppression(DeleteAlarmSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified alarm suppression. For more information, see Removing an Alarm-wide Suppression and Removing a Dimension-Specific Alarm Suppression. <br/> For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<DeleteAlarmSuppressionResponse> DeleteAlarmSuppression(DeleteAlarmSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAlarmSuppressionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAlarmSuppressionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAlarmSuppression API.
GetAlarm(GetAlarmRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified alarm. For more information, see Getting an Alarm. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<GetAlarmResponse> GetAlarm(GetAlarmRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAlarmRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAlarmResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAlarm API.
GetAlarmHistory(GetAlarmHistoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get the history of the specified alarm. For more information, see Getting History of an Alarm. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<GetAlarmHistoryResponse> GetAlarmHistory(GetAlarmHistoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAlarmHistoryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAlarmHistoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAlarmHistory API.
GetAlarmSuppression(GetAlarmSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified alarm suppression. For more information, see Getting an Alarm-wide Suppression. <br/> For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<GetAlarmSuppressionResponse> GetAlarmSuppression(GetAlarmSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAlarmSuppressionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAlarmSuppressionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAlarmSuppression API.
ListAlarmSuppressions(ListAlarmSuppressionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists alarm suppressions for the specified alarm. For more information, see Listing Alarm Suppressions. <br/> For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<ListAlarmSuppressionsResponse> ListAlarmSuppressions(ListAlarmSuppressionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAlarmSuppressionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAlarmSuppressionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAlarmSuppressions API.
ListAlarms(ListAlarmsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the alarms for the specified compartment. For more information, see Listing Alarms. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<ListAlarmsResponse> ListAlarms(ListAlarmsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAlarmsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAlarmsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAlarms API.
ListAlarmsStatus(ListAlarmsStatusRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}. Optionally filter by resource or status value. <br/> For more information, see Listing Alarm Statuses. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<ListAlarmsStatusResponse> ListAlarmsStatus(ListAlarmsStatusRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAlarmsStatusRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAlarmsStatusResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAlarmsStatus API.
ListMetrics(ListMetricsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For more information, see Listing Metric Definitions. For information about metrics, see Metrics Overview. For important limits information, see Limits on Monitoring. <br/> Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
Declaration
public Task<ListMetricsResponse> ListMetrics(ListMetricsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMetricsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListMetricsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMetrics API.
PostMetricData(PostMetricDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Publishes raw metric data points to the Monitoring service. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). <br/> For more information about publishing metrics, see Publishing Custom Metrics and Custom Metrics Walkthrough. For information about developing a metric-posting client, see Developer Guide. For an example client, see MonitoringMetricPostExample.java. For important limits information, see Limits on Monitoring. <br/> Per-call limits information follows. <br/>
- Dimensions per metric group*. Maximum: 20. Minimum: 1.
- Unique metric streams*. Maximum: 50.
- Transactions Per Second (TPS) per-tenancy limit for this operation: 50.
<br/>
*A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits.
A dimension is a qualifier provided in a metric definition.
A metric stream is an individual set of aggregated data for a metric with zero or more dimension values.
For more information about metric-related concepts, see
Monitoring Concepts.
<br/>
Note: The endpoints for this operation differ from other Monitoring operations. Replace the string
telemetry
withtelemetry-ingestion
in the endpoint, as in the following example: <br/> https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com
Declaration
public Task<PostMetricDataResponse> PostMetricData(PostMetricDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PostMetricDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PostMetricDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PostMetricData API.
RemoveAlarmSuppression(RemoveAlarmSuppressionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes any existing suppression for the specified alarm. For more information, see Removing Suppression from an Alarm. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<RemoveAlarmSuppressionResponse> RemoveAlarmSuppression(RemoveAlarmSuppressionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveAlarmSuppressionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveAlarmSuppressionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveAlarmSuppression API.
RetrieveDimensionStates(RetrieveDimensionStatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. Optionally filter by status value and one or more dimension key-value pairs. <br/> For more information, see Listing Metric Stream Status in an Alarm. <br/> For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<RetrieveDimensionStatesResponse> RetrieveDimensionStates(RetrieveDimensionStatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RetrieveDimensionStatesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RetrieveDimensionStatesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RetrieveDimensionStates API.
SummarizeAlarmSuppressionHistory(SummarizeAlarmSuppressionHistoryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see Getting Suppression History for an Alarm. <br/> For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<SummarizeAlarmSuppressionHistoryResponse> SummarizeAlarmSuppressionHistory(SummarizeAlarmSuppressionHistoryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SummarizeAlarmSuppressionHistoryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SummarizeAlarmSuppressionHistoryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SummarizeAlarmSuppressionHistory API.
SummarizeMetricsData(SummarizeMetricsDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For more information, see Querying Metric Data and Creating a Query. For important limits information, see Limits on Monitoring. <br/> Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
Declaration
public Task<SummarizeMetricsDataResponse> SummarizeMetricsData(SummarizeMetricsDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SummarizeMetricsDataRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SummarizeMetricsDataResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SummarizeMetricsData API.
UpdateAlarm(UpdateAlarmRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified alarm. For more information, see Updating an Alarm. For important limits information, see Limits on Monitoring. <br/> 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.
Declaration
public Task<UpdateAlarmResponse> UpdateAlarm(UpdateAlarmRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAlarmRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAlarmResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAlarm API.