Interface SummaryLogs
public interface SummaryLogs
An immutable client-side representation of SummaryLogs.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the SummaryLogs definition.static interfaceThe SummaryLogs definition stages.static interfaceThe template for SummaryLogs update.static interfaceThe SummaryLogs update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the description property: The description of the Summary rule.Gets the displayName property: The display name of the Summary rule.id()Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.SummaryLogsInner object.isActive()Gets the isActive property: Indicates if Summary rule is active.name()Gets the name property: The name of the resource.Gets the provisioningState property: Summary rule is in provisioning state.refresh()Refreshes the resource to sync with Azure.refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.Gets the name of the resource group.voidretryBin(SummaryLogsRetryBin parameters) Retries a failed Summary rule bin.voidretryBin(SummaryLogsRetryBin parameters, com.azure.core.util.Context context) Retries a failed Summary rule bin.Gets the ruleDefinition property: Rule definition parameters.ruleType()Gets the ruleType property: SummaryRules rule type: User.voidstart()Starts an inactive Summary rule.voidstart(com.azure.core.util.Context context) Starts an inactive Summary rule.Gets the statusCode property: Indicates the reason for rule deactivation.voidstop()Stops an active Summary rule.com.azure.core.http.rest.Response<Void> stopWithResponse(com.azure.core.util.Context context) Stops an active Summary rule.com.azure.core.management.SystemDataGets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.type()Gets the type property: The type of the resource.update()Begins update for the SummaryLogs resource.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
-
type
-
systemData
com.azure.core.management.SystemData systemData()Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.- Returns:
- the systemData value.
-
ruleType
RuleTypeEnum ruleType()Gets the ruleType property: SummaryRules rule type: User.- Returns:
- the ruleType value.
-
displayName
String displayName()Gets the displayName property: The display name of the Summary rule.- Returns:
- the displayName value.
-
description
String description()Gets the description property: The description of the Summary rule.- Returns:
- the description value.
-
isActive
Boolean isActive()Gets the isActive property: Indicates if Summary rule is active. If not, Summary rule execution stops.- Returns:
- the isActive value.
-
statusCode
StatusCodeEnum statusCode()Gets the statusCode property: Indicates the reason for rule deactivation.- Returns:
- the statusCode value.
-
provisioningState
SummaryLogsProvisioningState provisioningState()Gets the provisioningState property: Summary rule is in provisioning state. If set to 'updating' or 'deleting', indicates a resource lock due to an ongoing operation, preventing any update to the Summary rule until the operation is complete.- Returns:
- the provisioningState value.
-
ruleDefinition
RuleDefinition ruleDefinition()Gets the ruleDefinition property: Rule definition parameters.- Returns:
- the ruleDefinition value.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
SummaryLogsInner innerModel()Gets the inner com.azure.resourcemanager.loganalytics.fluent.models.SummaryLogsInner object.- Returns:
- the inner object.
-
update
SummaryLogs.Update update()Begins update for the SummaryLogs resource.- Returns:
- the stage of resource update.
-
refresh
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-
start
void start()Starts an inactive Summary rule.- Throws:
com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
start
void start(com.azure.core.util.Context context) Starts an inactive Summary rule.- Parameters:
context- The context to associate with this operation.- Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
stopWithResponse
Stops an active Summary rule.- Parameters:
context- The context to associate with this operation.- Returns:
- the
Response. - Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
stop
void stop()Stops an active Summary rule.- Throws:
com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
retryBin
Retries a failed Summary rule bin.- Parameters:
parameters- The parameters required to retry a Summary rule bin.- Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
retryBin
Retries a failed Summary rule bin.- Parameters:
parameters- The parameters required to retry a Summary rule bin.context- The context to associate with this operation.- Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-