Share via


SmartGroupCollection.GetAllAsync Method

Definition

Overloads

GetAllAsync(SmartGroupCollectionGetAllOptions, CancellationToken)

List all the Smart Groups within a specified subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
  • Operation Id: SmartGroups_GetAll
GetAllAsync(String, String, String, Nullable<MonitorServiceSourceForAlert>, Nullable<MonitorCondition>, Nullable<ServiceAlertSeverity>, Nullable<ServiceAlertState>, Nullable<TimeRangeFilter>, Nullable<Int64>, Nullable<SmartGroupsSortByField>, Nullable<AlertsManagementQuerySortOrder>, CancellationToken)

List all the Smart Groups within a specified subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
  • Operation Id: SmartGroups_GetAll

GetAllAsync(SmartGroupCollectionGetAllOptions, CancellationToken)

Source:
SmartGroupCollection.cs
Source:
SmartGroupCollection.cs

List all the Smart Groups within a specified subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
  • Operation Id: SmartGroups_GetAll
public virtual Azure.AsyncPageable<Azure.ResourceManager.AlertsManagement.SmartGroupResource> GetAllAsync (Azure.ResourceManager.AlertsManagement.Models.SmartGroupCollectionGetAllOptions options, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAllAsync : Azure.ResourceManager.AlertsManagement.Models.SmartGroupCollectionGetAllOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.AlertsManagement.SmartGroupResource>
override this.GetAllAsync : Azure.ResourceManager.AlertsManagement.Models.SmartGroupCollectionGetAllOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.AlertsManagement.SmartGroupResource>
Public Overridable Function GetAllAsync (options As SmartGroupCollectionGetAllOptions, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SmartGroupResource)

Parameters

options
SmartGroupCollectionGetAllOptions

A property bag which contains all the parameters of this method except the LRO qualifier and request context parameter.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of SmartGroupResource that may take multiple service requests to iterate over.

Applies to

GetAllAsync(String, String, String, Nullable<MonitorServiceSourceForAlert>, Nullable<MonitorCondition>, Nullable<ServiceAlertSeverity>, Nullable<ServiceAlertState>, Nullable<TimeRangeFilter>, Nullable<Int64>, Nullable<SmartGroupsSortByField>, Nullable<AlertsManagementQuerySortOrder>, CancellationToken)

Source:
SmartGroupCollection.cs
Source:
SmartGroupCollection.cs

List all the Smart Groups within a specified subscription.

  • Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
  • Operation Id: SmartGroups_GetAll
public virtual Azure.AsyncPageable<Azure.ResourceManager.AlertsManagement.SmartGroupResource> GetAllAsync (string targetResource = default, string targetResourceGroup = default, string targetResourceType = default, Azure.ResourceManager.AlertsManagement.Models.MonitorServiceSourceForAlert? monitorService = default, Azure.ResourceManager.AlertsManagement.Models.MonitorCondition? monitorCondition = default, Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSeverity? severity = default, Azure.ResourceManager.AlertsManagement.Models.ServiceAlertState? smartGroupState = default, Azure.ResourceManager.AlertsManagement.Models.TimeRangeFilter? timeRange = default, long? pageCount = default, Azure.ResourceManager.AlertsManagement.Models.SmartGroupsSortByField? sortBy = default, Azure.ResourceManager.AlertsManagement.Models.AlertsManagementQuerySortOrder? sortOrder = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAllAsync : string * string * string * Nullable<Azure.ResourceManager.AlertsManagement.Models.MonitorServiceSourceForAlert> * Nullable<Azure.ResourceManager.AlertsManagement.Models.MonitorCondition> * Nullable<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSeverity> * Nullable<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertState> * Nullable<Azure.ResourceManager.AlertsManagement.Models.TimeRangeFilter> * Nullable<int64> * Nullable<Azure.ResourceManager.AlertsManagement.Models.SmartGroupsSortByField> * Nullable<Azure.ResourceManager.AlertsManagement.Models.AlertsManagementQuerySortOrder> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.AlertsManagement.SmartGroupResource>
override this.GetAllAsync : string * string * string * Nullable<Azure.ResourceManager.AlertsManagement.Models.MonitorServiceSourceForAlert> * Nullable<Azure.ResourceManager.AlertsManagement.Models.MonitorCondition> * Nullable<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertSeverity> * Nullable<Azure.ResourceManager.AlertsManagement.Models.ServiceAlertState> * Nullable<Azure.ResourceManager.AlertsManagement.Models.TimeRangeFilter> * Nullable<int64> * Nullable<Azure.ResourceManager.AlertsManagement.Models.SmartGroupsSortByField> * Nullable<Azure.ResourceManager.AlertsManagement.Models.AlertsManagementQuerySortOrder> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.AlertsManagement.SmartGroupResource>
Public Overridable Function GetAllAsync (Optional targetResource As String = Nothing, Optional targetResourceGroup As String = Nothing, Optional targetResourceType As String = Nothing, Optional monitorService As Nullable(Of MonitorServiceSourceForAlert) = Nothing, Optional monitorCondition As Nullable(Of MonitorCondition) = Nothing, Optional severity As Nullable(Of ServiceAlertSeverity) = Nothing, Optional smartGroupState As Nullable(Of ServiceAlertState) = Nothing, Optional timeRange As Nullable(Of TimeRangeFilter) = Nothing, Optional pageCount As Nullable(Of Long) = Nothing, Optional sortBy As Nullable(Of SmartGroupsSortByField) = Nothing, Optional sortOrder As Nullable(Of AlertsManagementQuerySortOrder) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SmartGroupResource)

Parameters

targetResource
String

Filter by target resource( which is full ARM ID) Default value is select all.

targetResourceGroup
String

Filter by target resource group name. Default value is select all.

targetResourceType
String

Filter by target resource type. Default value is select all.

monitorService
Nullable<MonitorServiceSourceForAlert>

Filter by monitor service which generates the alert instance. Default value is select all.

monitorCondition
Nullable<MonitorCondition>

Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.

severity
Nullable<ServiceAlertSeverity>

Filter by severity. Default value is select all.

smartGroupState
Nullable<ServiceAlertState>

Filter by state of the smart group. Default value is to select all.

timeRange
Nullable<TimeRangeFilter>

Filter by time range by below listed values. Default value is 1 day.

pageCount
Nullable<Int64>

Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25.

sortBy
Nullable<SmartGroupsSortByField>

Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'.

sortOrder
Nullable<AlertsManagementQuerySortOrder>

Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of SmartGroupResource that may take multiple service requests to iterate over.

Applies to