@azure/arm-monitor package

Classes

MonitorClient

Interfaces

AccessModeSettings

Properties that define the scope private link mode settings.

AccessModeSettingsExclusion

Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection.

AccessRule

Access rule in a network security perimeter configuration profile

AccessRuleProperties

Properties of Access Rule

ActionDetail

The action detail

ActionGroup

An Azure action group.

ActionGroupPatch

Action group settings for patch operations.

ActionGroupPatchBody

An action group object for the body of patch operations.

ActionGroupResource

An action group resource.

ActionGroupsCreateNotificationsAtActionGroupResourceLevelOptionalParams

Optional parameters.

ActionGroupsCreateOrUpdateOptionalParams

Optional parameters.

ActionGroupsDeleteOptionalParams

Optional parameters.

ActionGroupsEnableReceiverOptionalParams

Optional parameters.

ActionGroupsGetNSPOptionalParams

Optional parameters.

ActionGroupsGetOptionalParams

Optional parameters.

ActionGroupsGetTestNotificationsAtActionGroupResourceLevelOptionalParams

Optional parameters.

ActionGroupsListByResourceGroupOptionalParams

Optional parameters.

ActionGroupsListBySubscriptionIdOptionalParams

Optional parameters.

ActionGroupsListNSPOptionalParams

Optional parameters.

ActionGroupsOperations

Interface representing a ActionGroups operations.

ActionGroupsReconcileNSPOptionalParams

Optional parameters.

ActionGroupsUpdateOptionalParams

Optional parameters.

ActionList

A list of Activity Log Alert rule actions.

Actions

Actions to invoke when the alert fires.

ActivityLogAlertActionGroup

A pointer to an Azure Action Group.

ActivityLogAlertErrorResponse

The error response.

ActivityLogAlertResource

An Activity Log Alert rule resource.

ActivityLogAlertsCreateOrUpdateOptionalParams

Optional parameters.

ActivityLogAlertsDeleteOptionalParams

Optional parameters.

ActivityLogAlertsGetOptionalParams

Optional parameters.

ActivityLogAlertsListByResourceGroupOptionalParams

Optional parameters.

ActivityLogAlertsListBySubscriptionIdOptionalParams

Optional parameters.

ActivityLogAlertsOperations

Interface representing a ActivityLogAlerts operations.

ActivityLogAlertsUpdateOptionalParams

Optional parameters.

ActivityLogsListOptionalParams

Optional parameters.

ActivityLogsOperations

Interface representing a ActivityLogs operations.

AdxDestination

Azure Data Explorer (Adx) destination.

AgentSetting

A setting used to control an agent behavior on a host machine

AgentSettingsSpec

An agent setting

AlertRuleAllOfCondition

An Activity Log Alert rule condition that is met when all its member conditions are met.

AlertRuleAnyOfOrLeafCondition

An Activity Log Alert rule condition that is met when all its member conditions are met. Each condition can be of one of the following types: Important: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition.

  • Leaf Condition - must contain 'field' and either 'equals' or 'containsAny'. Please note, 'anyOf' should not be set in a Leaf Condition.
  • AnyOf Condition - must contain only 'anyOf' (which is an array of Leaf Conditions). Please note, 'field', 'equals' and 'containsAny' should not be set in an AnyOf Condition.
AlertRuleIncidentsGetOptionalParams

Optional parameters.

AlertRuleIncidentsListByAlertRuleOptionalParams

Optional parameters.

AlertRuleIncidentsOperations

Interface representing a AlertRuleIncidents operations.

AlertRuleLeafCondition

An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. This condition must contain 'field' and either 'equals' or 'containsAny'.

AlertRulePatchObject

An Activity Log Alert rule object for the body of patch operations.

AlertRulePatchProperties

An Activity Log Alert rule properties for patch operations.

AlertRuleProperties

An Azure Activity Log Alert rule.

ApplicationInsights

model interface ApplicationInsights

ArmErrorDetail

The error detail.

ArmErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

ArmRoleReceiver

An arm role receiver.

AutomationRunbookReceiver

The Azure Automation Runbook notification receiver.

AutoscaleErrorResponse

Describes the format of Error response.

AutoscaleErrorResponseError

The error object.

AutoscaleNotification

Autoscale notification.

AutoscaleProfile

Autoscale profile.

AutoscaleSetting

A setting that contains all of the configuration for the automatic scaling of a resource.

AutoscaleSettingResource

The autoscale setting resource.

AutoscaleSettingResourcePatch

The autoscale setting object for patch operations.

AutoscaleSettingsCreateOrUpdateOptionalParams

Optional parameters.

AutoscaleSettingsDeleteOptionalParams

Optional parameters.

AutoscaleSettingsGetOptionalParams

Optional parameters.

AutoscaleSettingsListByResourceGroupOptionalParams

Optional parameters.

AutoscaleSettingsListBySubscriptionOptionalParams

Optional parameters.

AutoscaleSettingsOperations

Interface representing a AutoscaleSettings operations.

AutoscaleSettingsUpdateOptionalParams

Optional parameters.

AzureAppPushReceiver

The Azure mobile App push notification receiver.

AzureFunctionReceiver

An azure function receiver.

AzureMonitorMetricsDestination

Azure Monitor Metrics destination.

AzureMonitorPrivateLinkScope

An Azure Monitor PrivateLinkScope definition.

AzureMonitorPrivateLinkScopeProperties

Properties that define a Azure Monitor PrivateLinkScope resource.

BaselineMetadata

Represents a baseline metadata value.

BaselinesListOptionalParams

Optional parameters.

BaselinesOperations

Interface representing a Baselines operations.

ColumnDefinition

Definition of custom data column.

CommonErrorResponse

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

Condition

A condition of the scheduled query rule.

ConditionFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.

ConfigurationAccessEndpointSpec

Definition of the endpoint used for accessing configuration.

Context

The context info

CreateNotificationsAtTenantActionGroupResourceLevelOptionalParams

Optional parameters.

DataCollectionEndpoint

Definition of data collection endpoint.

DataCollectionEndpointConfigurationAccess

The endpoint used by clients to access their configuration.

DataCollectionEndpointFailoverConfiguration

Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.

DataCollectionEndpointLogsIngestion

The endpoint used by clients to ingest logs.

DataCollectionEndpointMetadata

Metadata for the resource. This property can only be updated by Log Analytics Control Plane for Data Collection Endpoint with Log Analytics Destination.

DataCollectionEndpointMetricsIngestion

The endpoint used by clients to ingest metrics.

DataCollectionEndpointNetworkAcls

Network access control rules for the endpoints.

DataCollectionEndpointResource

Definition of ARM tracked top level resource.

DataCollectionEndpointResourceIdentity

Managed service identity of the resource.

DataCollectionEndpointResourceProperties

model interface DataCollectionEndpointResourceProperties

DataCollectionEndpointResourceSku

The SKU of the resource.

DataCollectionEndpointsCreateOptionalParams

Optional parameters.

DataCollectionEndpointsDeleteOptionalParams

Optional parameters.

DataCollectionEndpointsGetNSPOptionalParams

Optional parameters.

DataCollectionEndpointsGetOptionalParams

Optional parameters.

DataCollectionEndpointsListByResourceGroupOptionalParams

Optional parameters.

DataCollectionEndpointsListBySubscriptionOptionalParams

Optional parameters.

DataCollectionEndpointsListNSPOptionalParams

Optional parameters.

DataCollectionEndpointsOperations

Interface representing a DataCollectionEndpoints operations.

DataCollectionEndpointsReconcileNSPOptionalParams

Optional parameters.

DataCollectionEndpointsUpdateOptionalParams

Optional parameters.

DataCollectionRule

Definition of what monitoring data to collect and where that data should be sent.

DataCollectionRuleAgentSettings

Agent settings used to modify agent behavior on a given host

DataCollectionRuleAssociation

Definition of association of a data collection rule with a monitored Azure resource.

DataCollectionRuleAssociationMetadata

Metadata about the resource

DataCollectionRuleAssociationProxyOnlyResource

Definition of generic ARM proxy resource.

DataCollectionRuleAssociationProxyOnlyResourceProperties

model interface DataCollectionRuleAssociationProxyOnlyResourceProperties

DataCollectionRuleAssociationsCreateOptionalParams

Optional parameters.

DataCollectionRuleAssociationsDeleteOptionalParams

Optional parameters.

DataCollectionRuleAssociationsGetOptionalParams

Optional parameters.

DataCollectionRuleAssociationsListByDataCollectionEndpointOptionalParams

Optional parameters.

DataCollectionRuleAssociationsListByResourceOptionalParams

Optional parameters.

DataCollectionRuleAssociationsListByRuleOptionalParams

Optional parameters.

DataCollectionRuleAssociationsOperations

Interface representing a DataCollectionRuleAssociations operations.

DataCollectionRuleDataSources

The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint.

DataCollectionRuleDestinations

The specification of destinations.

DataCollectionRuleDirectDataSources

The specification of direct data sources. This property is optional and can be omitted.

DataCollectionRuleEndpoints

Defines the ingestion endpoints to send data to via this rule.

DataCollectionRuleIngestionQuotas

The specification for ingestion limits

DataCollectionRuleMetadata

Metadata about the resource

DataCollectionRuleReferences

Defines all the references that may be used in other sections of the DCR

DataCollectionRuleResource

Definition of ARM tracked top level resource.

DataCollectionRuleResourceIdentity

Managed service identity of the resource.

DataCollectionRuleResourceProperties

model interface DataCollectionRuleResourceProperties

DataCollectionRuleResourceSku

The SKU of the resource.

DataCollectionRulesCreateOptionalParams

Optional parameters.

DataCollectionRulesDeleteOptionalParams

Optional parameters.

DataCollectionRulesGetOptionalParams

Optional parameters.

DataCollectionRulesListByResourceGroupOptionalParams

Optional parameters.

DataCollectionRulesListBySubscriptionOptionalParams

Optional parameters.

DataCollectionRulesOperations

Interface representing a DataCollectionRules operations.

DataCollectionRulesUpdateOptionalParams

Optional parameters.

DataContainer

Information about a container with data for a given resource.

DataFlow

Definition of which streams are sent to which destinations.

DataImportSources

model interface DataImportSources

DataImportSourcesEventHub

Definition of Event Hub configuration.

DataSourcesSpec

Specification of data sources that will be collected.

DataSourcesSpecDataImports

Specifications of pull based data sources

DestinationsSpec

Specification of destinations that can be used in data flows.

DestinationsSpecAzureMonitorMetrics

Azure Monitor Metrics destination.

DiagnosticSettings

The diagnostic settings.

DiagnosticSettingsCategory

The diagnostic settings Category.

DiagnosticSettingsCategoryGetOptionalParams

Optional parameters.

DiagnosticSettingsCategoryListOptionalParams

Optional parameters.

DiagnosticSettingsCategoryOperations

Interface representing a DiagnosticSettingsCategory operations.

DiagnosticSettingsCategoryResource

The diagnostic settings category resource.

DiagnosticSettingsCreateOrUpdateOptionalParams

Optional parameters.

DiagnosticSettingsDeleteOptionalParams

Optional parameters.

DiagnosticSettingsGetOptionalParams

Optional parameters.

DiagnosticSettingsListOptionalParams

Optional parameters.

DiagnosticSettingsOperations

Interface representing a DiagnosticSettings operations.

DiagnosticSettingsResource

The diagnostic setting resource.

Dimension

Dimension splitting and filtering definition

DirectDataSourcesSpec

Specification of direct data sources that will be collected.

DynamicMetricCriteria

Criterion for dynamic threshold.

DynamicPromQLCriteria

The criterion for dynamic prom query.

DynamicThresholdFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert.

EmailNotification

Email notification of an autoscale event.

EmailReceiver

An email receiver.

EnableRequest

Describes a receiver that should be resubscribed.

EndpointsSpec

This defines all the ingestion endpoints that can be used by this rule

EnrichmentData

All the enrichment data sources referenced in data flows

ErrorAdditionalInfo

The resource management error additional info.

ErrorContract

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorDetail

Describes details of an error response.

ErrorDetailAdditionalInfoItem

model interface ErrorDetailAdditionalInfoItem

ErrorModel

Error details.

ErrorResponse

Describes the format of Error response.

ErrorResponseCommonV2

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

ErrorResponseError

model interface ErrorResponseError

ErrorResponseErrorAdditionalInfoItem

model interface ErrorResponseErrorAdditionalInfoItem

EtwProviderDataSource

Enables an ETW provider logs to be collected by this data collection rule.

EventCategoriesListOptionalParams

Optional parameters.

EventCategoriesOperations

Interface representing a EventCategories operations.

EventData

The Azure event log entries are of type EventData

EventHubDataSource

model interface EventHubDataSource

EventHubDestination

model interface EventHubDestination

EventHubDirectDestination

model interface EventHubDirectDestination

EventHubReceiver

An Event hub receiver.

ExtensionDataSource

Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent. Collected from either Windows and Linux machines, depending on which extension is defined.

ExtensionResource

The base extension resource.

FailoverConfigurationSpec

model interface FailoverConfigurationSpec

GetTestNotificationsAtTenantActionGroupResourceLevelOptionalParams

Optional parameters.

HttpRequestInfo

The Http request info.

Identity

Identity for the resource.

IisLogsDataSource

Enables IIS logs to be collected by this data collection rule.

Incident

An alert incident indicates the activation status of an alert rule.

IncidentReceiver

An Incident receiver.

IncidentServiceConnection

The connection info for Incident Receiver.

IngestionQuotas

model interface IngestionQuotas

IngestionQuotasLogs

model interface IngestionQuotasLogs

ItsmReceiver

An Itsm receiver.

LocalizableString

The localizable string class.

LocationSpec

model interface LocationSpec

LogAnalyticsDestination

Log Analytics destination.

LogFileSettings

Settings for different log file formats

LogFileSettingsText

Text settings

LogFileTextSettings

Settings for text log files

LogFilesDataSource

Definition of which custom log files will be collected by this data collection rule

LogFilesDataSourceSettings

The log files specific settings.

LogProfileProperties

The log profile properties.

LogProfileResource

The log profile resource.

LogProfileResourcePatch

The log profile resource for patch operations.

LogProfilesCreateOrUpdateOptionalParams

Optional parameters.

LogProfilesDeleteOptionalParams

Optional parameters.

LogProfilesGetOptionalParams

Optional parameters.

LogProfilesListOptionalParams

Optional parameters.

LogProfilesOperations

Interface representing a LogProfiles operations.

LogProfilesUpdateOptionalParams

Optional parameters.

LogSettings

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.

LogicAppReceiver

A logic app receiver.

LogsIngestionEndpointSpec

Definition of the endpoint used for ingesting logs.

LogsQuotaSpec

model interface LogsQuotaSpec

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Metadata

Metadata about the resource

MetadataValue

Represents a metric metadata value.

Metric

The result data of a query.

MetricAlertAction

An alert action.

MetricAlertCriteria

The rule criteria that defines the conditions of the alert rule.

MetricAlertErrorResponse

Describes the format of Error response.

MetricAlertMultipleResourceMultipleMetricCriteria

Specifies the metric alert criteria for multiple resource that has multiple metric criteria.

MetricAlertProperties

An alert rule.

MetricAlertPropertiesPatch

An alert rule properties for patch.

MetricAlertResource

The metric alert resource.

MetricAlertResourcePatch

The metric alert resource for patch operations.

MetricAlertSingleResourceMultipleMetricCriteria

Specifies the metric alert criteria for a single resource that has multiple metric criteria.

MetricAlertStatus

An alert status.

MetricAlertStatusCollection

Represents a collection of alert rule resources.

MetricAlertStatusProperties

An alert status properties.

MetricAlertsCreateOrUpdateOptionalParams

Optional parameters.

MetricAlertsDeleteOptionalParams

Optional parameters.

MetricAlertsGetOptionalParams

Optional parameters.

MetricAlertsListByResourceGroupOptionalParams

Optional parameters.

MetricAlertsListBySubscriptionOptionalParams

Optional parameters.

MetricAlertsOperations

Interface representing a MetricAlerts operations.

MetricAlertsStatusListByNameOptionalParams

Optional parameters.

MetricAlertsStatusListOptionalParams

Optional parameters.

MetricAlertsStatusOperations

Interface representing a MetricAlertsStatus operations.

MetricAlertsUpdateOptionalParams

Optional parameters.

MetricAvailability

Metric availability specifies the time grain (aggregation interval or frequency) and the retention period for that time grain.

MetricBaselinesErrorResponse

Describes the format of Error response.

MetricBaselinesProperties

The response to a metric baselines query.

MetricCriteria

Criterion to filter metrics.

MetricDefinition

Metric definition class specifies the metadata for a metric.

MetricDefinitionsListAtSubscriptionScopeOptionalParams

Optional parameters.

MetricDefinitionsListOptionalParams

Optional parameters.

MetricDefinitionsOperations

Interface representing a MetricDefinitions operations.

MetricDimension

Specifies a metric dimension.

MetricNamespace

Metric namespace class specifies the metadata for a metric namespace.

MetricNamespaceName

The fully qualified metric namespace name.

MetricNamespacesListOptionalParams

Optional parameters.

MetricNamespacesOperations

Interface representing a MetricNamespaces operations.

MetricSettings

Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric.

MetricSingleDimension

The metric dimension name and value.

MetricTrigger

The trigger that results in a scaling action.

MetricValue

Represents a metric value.

MetricsIngestionEndpointSpec

Definition of the endpoint used for ingesting metrics.

MetricsListAtSubscriptionScopeOptionalParams

Optional parameters.

MetricsListAtSubscriptionScopePostOptionalParams

Optional parameters.

MetricsListOptionalParams

Optional parameters.

MetricsOperations

Interface representing a Metrics operations.

MicrosoftFabricDestination

Microsoft Fabric destination (non-Azure).

MonitorClientOptionalParams

Optional parameters for the client.

MonitoringAccountDestination

Monitoring account destination.

MultiMetricCriteria

The types of conditions for a multi resource alert.

MultiPromQLCriteria

The types of conditions for a multi query metric alert.

NetworkRuleSet

Definition of the network rules.

NetworkSecurityPerimeter

Information about a network security perimeter (NSP)

NetworkSecurityPerimeterConfiguration

Network security perimeter (NSP) configuration resource

NetworkSecurityPerimeterConfigurationProperties

Network security configuration properties.

NetworkSecurityProfile

Network security perimeter configuration profile

NotificationRequestBody

The request body which contain contact detail metadata

OperationStatus

The status of operation.

OtelDataSourceResourceAttributeRouting

Enables OTLP (logs, traces, and metrics) payload routing

OtelLogsDataSource

Enables Otel logs to be collected by this data collection rule.

OtelLogsDataSourceResourceAttributeRouting

Specifies the routing policy based on OTLP payload resource attributes to route subset of the payload according to matching resource attribute.

OtelLogsDirectDataSource

model interface OtelLogsDirectDataSource

OtelMetricsDataSource

Definition of OTel metrics configuration.

OtelMetricsDataSourceResourceAttributeRouting

Specifies the routing policy based on OTLP payload resource attributes to route subset of the payload according to matching resource attribute.

OtelMetricsDirectDataSource

Definition of OTel metrics configuration.

OtelTracesDataSource

Enables Otel Traces to be collected by this data collection rule.

OtelTracesDataSourceResourceAttributeRouting

Specifies the routing policy based on OTLP payload resource attributes to route subset of the payload according to matching resource attribute.

OtelTracesDirectDataSource

Enables Otel Traces to be collected by this data collection rule.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PerfCounterDataSource

Definition of which performance counters will be collected and how they will be collected by this data collection rule. Collected from both Windows and Linux machines where the counter is present.

PerformanceCountersOTelDataSource

Definition of which Open Telemetry performance counters will be collected and how they will be collected by this data collection rule. Collected from both Windows and Linux machines where the counter is present.

PlatformTelemetryDataSource

Definition of platform telemetry data source configuration

PredictiveAutoscalePolicy

The parameters for enabling predictive autoscale.

PredictiveMetricGetOptionalParams

Optional parameters.

PredictiveMetricOperations

Interface representing a PredictiveMetric operations.

PredictiveResponse

The response to a metrics query.

PredictiveValue

Represents a predictive metric value in the given bucket.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connection associated with the specified storage account

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByPrivateLinkScopeOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateLinkResource

A private link resource

PrivateLinkResourceListResult

The response of a PrivateLinkResource list operation.

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByPrivateLinkScopeOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

PrivateLinkScopeOperationStatusGetOptionalParams

Optional parameters.

PrivateLinkScopeOperationStatusOperations

Interface representing a PrivateLinkScopeOperationStatus operations.

PrivateLinkScopedResource

model interface PrivateLinkScopedResource

PrivateLinkScopedResourcesCreateOrUpdateOptionalParams

Optional parameters.

PrivateLinkScopedResourcesDeleteOptionalParams

Optional parameters.

PrivateLinkScopedResourcesGetOptionalParams

Optional parameters.

PrivateLinkScopedResourcesListByPrivateLinkScopeOptionalParams

Optional parameters.

PrivateLinkScopedResourcesOperations

Interface representing a PrivateLinkScopedResources operations.

PrivateLinkScopesCreateOrUpdateOptionalParams

Optional parameters.

PrivateLinkScopesDeleteOptionalParams

Optional parameters.

PrivateLinkScopesGetOptionalParams

Optional parameters.

PrivateLinkScopesListByResourceGroupOptionalParams

Optional parameters.

PrivateLinkScopesListOptionalParams

Optional parameters.

PrivateLinkScopesOperations

Interface representing a PrivateLinkScopes operations.

PrivateLinkScopesUpdateTagsOptionalParams

Optional parameters.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

PromQLCriteria

Specifies the PromQL criteria for the metric alert resource.

PrometheusForwarderDataSource

Definition of Prometheus metrics forwarding configuration.

ProvisioningIssue

Describes a provisioning issue for a network security perimeter configuration

ProvisioningIssueProperties

Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

QueryFailingPeriods

Configuration for failing periods in query-based alerts.

Recurrence

The repeating times at which this profile begins. This element is not used if the FixedDate element is used.

RecurrentSchedule

The scheduling constraints for when the profile begins.

ReferencesSpec

This section defines all the references that may be used in other sections of the DCR

ReferencesSpecEnrichmentData

All the enrichment data sources referenced in data flows

ResolveConfiguration

model interface ResolveConfiguration

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceAssociation

Information about resource association

ResourceForUpdate

Definition of ARM tracked top level resource properties for update operation.

ResourceForUpdateIdentity

Managed Service Identity.

Response

The response to a metrics query.

ResponseWithError

An error response from the API.

RestorePollerOptions
RetentionPolicy

Specifies the retention policy for the log.

RuleResolveConfiguration

TBD. Relevant only for rules of the kind LogAlert.

ScaleAction

The parameters for the scaling action.

ScaleCapacity

The number of instances that can be used during this profile.

ScaleRule

A rule that provide the triggers and parameters for the scaling action.

ScaleRuleMetricDimension

Specifies an auto scale rule metric dimension.

ScheduledQueryRuleCriteria

The rule criteria that defines the conditions of the scheduled query rule.

ScheduledQueryRuleGetNSPOptionalParams

Optional parameters.

ScheduledQueryRuleListNSPOptionalParams

Optional parameters.

ScheduledQueryRuleOperations

Interface representing a ScheduledQueryRule operations.

ScheduledQueryRuleProperties

scheduled query rule Definition

ScheduledQueryRuleReconcileNSPOptionalParams

Optional parameters.

ScheduledQueryRuleResource

The scheduled query rule resource.

ScheduledQueryRuleResourcePatch

The scheduled query rule resource for patch operations.

ScheduledQueryRulesCreateOrUpdateOptionalParams

Optional parameters.

ScheduledQueryRulesDeleteOptionalParams

Optional parameters.

ScheduledQueryRulesGetOptionalParams

Optional parameters.

ScheduledQueryRulesListByResourceGroupOptionalParams

Optional parameters.

ScheduledQueryRulesListBySubscriptionOptionalParams

Optional parameters.

ScheduledQueryRulesOperations

Interface representing a ScheduledQueryRules operations.

ScheduledQueryRulesUpdateOptionalParams

Optional parameters.

ScopedResource

A private link scoped resource

ScopedResourceProperties

Properties of a private link scoped resource.

SenderAuthorization

the authorization used by the user who has performed the operation that led to this event. This captures the RBAC properties of the event. These usually include the 'action', 'role' and the 'scope'

ServiceDiagnosticSettings

The diagnostic settings for service.

ServiceDiagnosticSettingsCreateOrUpdateOptionalParams

Optional parameters.

ServiceDiagnosticSettingsGetOptionalParams

Optional parameters.

ServiceDiagnosticSettingsOperations

Interface representing a ServiceDiagnosticSettings operations.

ServiceDiagnosticSettingsResource

Description of a service diagnostic setting

ServiceDiagnosticSettingsResourcePatch

Service diagnostic setting resource for patch operations

ServiceDiagnosticSettingsUpdateOptionalParams

Optional parameters.

SimplePollerLike

A simple poller that can be used to poll a long running operation.

SingleBaseline

The baseline values for a single sensitivity value.

SingleMetricBaseline

The baseline results of a single metric.

Sku

The resource model definition representing SKU

SmsReceiver

An SMS receiver.

StaticPromQLCriteria

The criterion for static prom query.

StorageBlob

model interface StorageBlob

StorageBlobDestination

model interface StorageBlobDestination

StorageTableDestination

model interface StorageTableDestination

StreamDeclaration

Declaration of a custom stream.

SubscriptionScopeMetricDefinition

Metric definition class specifies the metadata for a metric.

SubscriptionScopeMetricsRequestBodyParameters

Query parameters can also be specified in the body, specifying the same parameter in both the body and query parameters will result in an error.

SyslogDataSource

Definition of which syslog data will be collected and how it will be collected. Only collected from Linux machines.

SystemData

Metadata pertaining to creation and last modification of the resource.

TagsResource

A container holding only the Tags for a resource, allowing the user to update the tags on a PrivateLinkScope instance.

TenantActionGroup

A tenant action group.

TenantActionGroupActionDetail

The action detail

TenantActionGroupPatchBody

A tenant action group object for the body of patch operations.

TenantActionGroupResource

A tenant action group resource.

TenantActionGroupTestNotificationDetailsResponse

The details of the test notification results.

TenantActionGroupWebhookReceiver

A webhook receiver.

TenantActionGroupsCreateOrUpdateOptionalParams

Optional parameters.

TenantActionGroupsDeleteOptionalParams

Optional parameters.

TenantActionGroupsGetOptionalParams

Optional parameters.

TenantActionGroupsListByManagementGroupIdOptionalParams

Optional parameters.

TenantActionGroupsOperations

Interface representing a TenantActionGroups operations.

TenantActionGroupsUpdateOptionalParams

Optional parameters.

TenantActivityLogsListOptionalParams

Optional parameters.

TenantActivityLogsOperations

Interface representing a TenantActivityLogs operations.

TenantNotificationRequestBody

The request body which contain contact detail metadata

TestNotificationDetailsResponse

The details of the test notification results.

TimeSeriesBaseline

The baseline values for a single time series.

TimeSeriesElement

A time series result type. The discriminator value is always TimeSeries in this case.

TimeWindow

A specific date-time for the profile.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UserAssignedIdentity

User assigned identity properties

UserIdentityProperties

Properties of the user assigned identity.

VMInsightsOnboardingStatus

VM Insights onboarding status for a resource.

VMInsightsOnboardingStatusProperties

Resource properties.

VoiceReceiver

A voice receiver.

WebhookNotification

Webhook notification of an autoscale event.

WebhookReceiver

A webhook receiver.

WebtestLocationAvailabilityCriteria

Specifies the metric alert rule criteria for a web test resource.

WindowsEventLogDataSource

Definition of which Windows Event Log events will be collected and how they will be collected. Only collected from Windows machines.

WindowsFirewallLogsDataSource

Enables Firewall logs to be collected by this data collection rule.

WorkspaceInfo

Information about a Log Analytics Workspace.

WorkspaceInfoProperties

Resource properties.

vMInsightsGetOnboardingStatusOptionalParams

Optional parameters.

vMInsightsOperations

Interface representing a vMInsights operations.

Type Aliases

AccessMode

Access mode types.
KnownAccessMode can be used interchangeably with AccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Open: Open
PrivateOnly: PrivateOnly

AccessRuleDirection

Direction of Access Rule
KnownAccessRuleDirection can be used interchangeably with AccessRuleDirection, this enum contains the known values that the service supports.

Known values supported by the service

Inbound: Applies to inbound network traffic to the secured resources.
Outbound: Applies to outbound network traffic from the secured resources

AggregationType

The aggregation type of the metric.

AggregationTypeEnum

The criteria time aggregation types. Previously undocumented values might be returned
KnownAggregationTypeEnum can be used interchangeably with AggregationTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Average: Average
Count: Count
Minimum: Minimum
Maximum: Maximum
Total: Total

AlertSeverity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
KnownAlertSeverity can be used interchangeably with AlertSeverity, this enum contains the known values that the service supports.

Known values supported by the service

0: 0
1: 1
2: 2
3: 3
4: 4

AzureSupportedClouds

The supported values for cloud setting as a string literal type

BaselineSensitivity

the sensitivity of the baseline.
KnownBaselineSensitivity can be used interchangeably with BaselineSensitivity, this enum contains the known values that the service supports.

Known values supported by the service

Low: Low
Medium: Medium
High: High

CategoryType

The type of the diagnostic settings category.
KnownCategoryType can be used interchangeably with CategoryType, this enum contains the known values that the service supports.

Known values supported by the service

Metrics: Metrics
Logs: Logs

ComparisonOperationType

the operator that is used to compare the metric data and the threshold.

ConditionOperator

The criteria operator. Relevant and required only for rules of the kind LogAlert.
KnownConditionOperator can be used interchangeably with ConditionOperator, this enum contains the known values that the service supports.

Known values supported by the service

Equals: Equals
GreaterThan: GreaterThan
GreaterThanOrEqual: GreaterThanOrEqual
LessThan: LessThan
LessThanOrEqual: LessThanOrEqual
GreaterOrLessThan: GreaterOrLessThan

ContinuablePage

An interface that describes a page of results.

CreatedByType

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

CriterionType

Specifies the type of threshold criteria. Previously undocumented values might be returned
KnownCriterionType can be used interchangeably with CriterionType, this enum contains the known values that the service supports.

Known values supported by the service

StaticThresholdCriterion: StaticThresholdCriterion
DynamicThresholdCriterion: DynamicThresholdCriterion

DataStatus

The status of VM Insights data from the resource. When reported as present the data array will contain information about the data containers to which data for the specified resource is being routed.
KnownDataStatus can be used interchangeably with DataStatus, this enum contains the known values that the service supports.

Known values supported by the service

present: present
notPresent: notPresent

DimensionOperator

Operator for dimension values
KnownDimensionOperator can be used interchangeably with DimensionOperator, this enum contains the known values that the service supports.

Known values supported by the service

Include: Include
Exclude: Exclude

DynamicThresholdOperator

The operator used to compare the metric value against the threshold. Previously undocumented values might be returned
KnownDynamicThresholdOperator can be used interchangeably with DynamicThresholdOperator, this enum contains the known values that the service supports.

Known values supported by the service

GreaterThan: GreaterThan
LessThan: LessThan
GreaterOrLessThan: GreaterOrLessThan

DynamicThresholdSensitivity

The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. Previously undocumented values might be returned
KnownDynamicThresholdSensitivity can be used interchangeably with DynamicThresholdSensitivity, this enum contains the known values that the service supports.

Known values supported by the service

Low: Low
Medium: Medium
High: High

EventLevel

the event level

IdentityType

Type of managed service identity.

IncidentManagementService

The incident management service type
KnownIncidentManagementService can be used interchangeably with IncidentManagementService, this enum contains the known values that the service supports.

Known values supported by the service

Icm: Icm

IssueType

Type of issue
KnownIssueType can be used interchangeably with IssueType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: Unknown issue type
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration.
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules.
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP.

Kind

Indicates the type of scheduled query rule. The default is LogAlert.
KnownKind can be used interchangeably with Kind, this enum contains the known values that the service supports.

Known values supported by the service

LogAlert: LogAlert
SimpleLogAlert: SimpleLogAlert
LogToMetric: LogToMetric

KnownAgentSettingName

The name of the setting. Must be part of the list of supported settings
KnownKnownAgentSettingName can be used interchangeably with KnownAgentSettingName, this enum contains the known values that the service supports.

Known values supported by the service

MaxDiskQuotaInMB: MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents: UseTimeReceivedForForwardedEvents
Tags: Tags

KnownColumnDefinitionType

The type of the column data.
KnownKnownColumnDefinitionType can be used interchangeably with KnownColumnDefinitionType, this enum contains the known values that the service supports.

Known values supported by the service

string: string
int: int
long: long
real: real
boolean: boolean
datetime: datetime
dynamic: dynamic

KnownDataCollectionEndpointProvisioningState

The resource provisioning state. This property is READ-ONLY.
KnownKnownDataCollectionEndpointProvisioningState can be used interchangeably with KnownDataCollectionEndpointProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

KnownDataCollectionEndpointResourceKind

The kind of the resource.
KnownKnownDataCollectionEndpointResourceKind can be used interchangeably with KnownDataCollectionEndpointResourceKind, this enum contains the known values that the service supports.

Known values supported by the service

Linux: Linux
Windows: Windows

KnownDataCollectionRuleAssociationProvisioningState

The resource provisioning state.
KnownKnownDataCollectionRuleAssociationProvisioningState can be used interchangeably with KnownDataCollectionRuleAssociationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

KnownDataCollectionRuleProvisioningState

The resource provisioning state.
KnownKnownDataCollectionRuleProvisioningState can be used interchangeably with KnownDataCollectionRuleProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

KnownDataCollectionRuleResourceKind

The kind of the resource.
KnownKnownDataCollectionRuleResourceKind can be used interchangeably with KnownDataCollectionRuleResourceKind, this enum contains the known values that the service supports.

Known values supported by the service

Linux: Linux
Windows: Windows

KnownDataFlowStreams

Type of KnownDataFlowStreams

KnownEtwProviderDataSourceLogLevel

Minimal level of detail to be logged
KnownKnownEtwProviderDataSourceLogLevel can be used interchangeably with KnownEtwProviderDataSourceLogLevel, this enum contains the known values that the service supports.

Known values supported by the service

Critical: Critical
Error: Error
Warning: Warning
Informational: Informational
Verbose: Verbose

KnownEtwProviderType

Provider type specification: By Manifest GUID or by Event Source name
KnownKnownEtwProviderType can be used interchangeably with KnownEtwProviderType, this enum contains the known values that the service supports.

Known values supported by the service

EventSource: EventSource
Manifest: Manifest

KnownExtensionDataSourceStreams

Type of KnownExtensionDataSourceStreams

KnownLocationSpecProvisioningStatus

The resource provisioning state in this location.
KnownKnownLocationSpecProvisioningStatus can be used interchangeably with KnownLocationSpecProvisioningStatus, this enum contains the known values that the service supports.

Known values supported by the service

Creating: Creating
Updating: Updating
Deleting: Deleting
Succeeded: Succeeded
Canceled: Canceled
Failed: Failed

KnownLogFileTextSettingsRecordStartTimestampFormat

One of the supported timestamp formats
KnownKnownLogFileTextSettingsRecordStartTimestampFormat can be used interchangeably with KnownLogFileTextSettingsRecordStartTimestampFormat, this enum contains the known values that the service supports.

Known values supported by the service

ISO 8601: ISO 8601
YYYY-MM-DD HH:MM:SS: YYYY-MM-DD HH:MM:SS
M/D/YYYY HH:MM:SS AM/PM: M/D/YYYY HH:MM:SS AM/PM
Mon DD, YYYY HH:MM:SS: Mon DD, YYYY HH:MM:SS
yyMMdd HH:mm:ss: yyMMdd HH:mm:ss
ddMMyy HH:mm:ss: ddMMyy HH:mm:ss
MMM d hh:mm:ss: MMM d hh:mm:ss
dd/MMM/yyyy:HH:mm:ss zzz: dd/MMM/yyyy:HH:mm:ss zzz
yyyy-MM-ddTHH:mm:ssK: yyyy-MM-ddTHH:mm:ssK

KnownLogFilesDataSourceFormat

The data format of the log files
KnownKnownLogFilesDataSourceFormat can be used interchangeably with KnownLogFilesDataSourceFormat, this enum contains the known values that the service supports.

Known values supported by the service

json: json
text: text

KnownOtelLogsDataSourceStreams

Type of KnownOtelLogsDataSourceStreams

KnownOtelLogsDirectDataSourceStreams

Type of KnownOtelLogsDirectDataSourceStreams

KnownOtelTracesDataSourceStreams

Type of KnownOtelTracesDataSourceStreams

KnownOtelTracesDirectDataSourceStreams

Type of KnownOtelTracesDirectDataSourceStreams

KnownPerfCounterDataSourceStreams

Type of KnownPerfCounterDataSourceStreams

KnownPerformanceCountersOTelDataSourceStreams

Type of KnownPerformanceCountersOTelDataSourceStreams

KnownPrometheusForwarderDataSourceStreams

Type of KnownPrometheusForwarderDataSourceStreams

KnownPublicNetworkAccessOptions

The configuration to set whether network access from public internet to the endpoints are allowed.
KnownKnownPublicNetworkAccessOptions can be used interchangeably with KnownPublicNetworkAccessOptions, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enabled
Disabled: Disabled
SecuredByPerimeter: SecuredByPerimeter

KnownStorageBlobLookupType

The type of lookup to perform on the blob
KnownKnownStorageBlobLookupType can be used interchangeably with KnownStorageBlobLookupType, this enum contains the known values that the service supports.

Known values supported by the service

String: String
Cidr: Cidr

KnownSyslogDataSourceFacilityNames

Type of KnownSyslogDataSourceFacilityNames

KnownSyslogDataSourceLogLevels

Type of KnownSyslogDataSourceLogLevels

KnownSyslogDataSourceStreams

Type of KnownSyslogDataSourceStreams

KnownWindowsEventLogDataSourceStreams

Type of KnownWindowsEventLogDataSourceStreams

KnownWindowsFirewallLogsDataSourceProfileFilter

Type of KnownWindowsFirewallLogsDataSourceProfileFilter

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None: No managed identity.
SystemAssigned: System assigned managed identity.
UserAssigned: User assigned managed identity.
SystemAssigned,UserAssigned: System and user assigned managed identity.

MetricAggregationType

The aggregation type of the metric.
KnownMetricAggregationType can be used interchangeably with MetricAggregationType, this enum contains the known values that the service supports.

Known values supported by the service

None: None
Average: Average
Count: Count
Minimum: Minimum
Maximum: Maximum
Total: Total

MetricAlertCriteriaUnion

Alias for MetricAlertCriteriaUnion

MetricClass

The class of the metric.
KnownMetricClass can be used interchangeably with MetricClass, this enum contains the known values that the service supports.

Known values supported by the service

Availability: Availability
Transactions: Transactions
Errors: Errors
Latency: Latency
Saturation: Saturation

MetricResultType

Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.
KnownMetricResultType can be used interchangeably with MetricResultType, this enum contains the known values that the service supports.

Known values supported by the service

Data: Data
Metadata: Metadata

MetricStatisticType

the metric statistic type. How the metrics from multiple instances are combined.

MetricUnit

The unit of the metric.
KnownMetricUnit can be used interchangeably with MetricUnit, this enum contains the known values that the service supports.

Known values supported by the service

Count: Unit of raw quantity.
Bytes: Unit of memory in bytes.
Seconds: Unit of time in seconds.
CountPerSecond: Rate unit of raw quantity per second.
BytesPerSecond: Rate unit of memory in bytes per second.
Percent: Percentage unit.
MilliSeconds: Unit of time in 1/1000th of a second.
ByteSeconds: Unit of data transfer or storage. It is the size of the data in bytes multiplied by the time it takes to transfer or store the data in seconds.
Unspecified: No specified unit.
Cores: Unit of processing power.
MilliCores: Unit of processing power in 1/1000th of a CPU core.
NanoCores: Unit of processing power in one billionth of a CPU core.
BitsPerSecond: Rate unit of binary digits per second.

MultiMetricCriteriaUnion

Alias for MultiMetricCriteriaUnion

MultiPromQLCriteriaUnion

Alias for MultiPromQLCriteriaUnion

NamespaceClassification

Kind of namespace
KnownNamespaceClassification can be used interchangeably with NamespaceClassification, this enum contains the known values that the service supports.

Known values supported by the service

Platform: Platform
Custom: Custom
Qos: Qos

NetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of a network security perimeter configuration that is being created or updated.
KnownNetworkSecurityPerimeterConfigurationProvisioningState can be used interchangeably with NetworkSecurityPerimeterConfigurationProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: The configuration was provisioned successfully.
Creating: The configuration is being created.
Updating: The configuration is being updated.
Deleting: The configuration is being deleted.
Accepted: The configuration request was accepted and provisioning has not started yet.
Failed: The configuration failed to provision.
Canceled: The configuration provisioning was canceled.

Odatatype

Specifies the type of the alert criteria. Previously undocumented values might be returned
KnownOdatatype can be used interchangeably with Odatatype, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria
Microsoft.Azure.Monitor.PromQLCriteria: Microsoft.Azure.Monitor.PromQLCriteria

OnboardingStatus

The onboarding status for the resource. Note that, a higher level scope, e.g., resource group or subscription, is considered onboarded if at least one resource under it is onboarded.
KnownOnboardingStatus can be used interchangeably with OnboardingStatus, this enum contains the known values that the service supports.

Known values supported by the service

onboarded: onboarded
notOnboarded: notOnboarded
unknown: unknown

OperationType

Type of OperationType

Operator

The criteria operator. Previously undocumented values might be returned
KnownOperator can be used interchangeably with Operator, this enum contains the known values that the service supports.

Known values supported by the service

Equals: Equals
GreaterThan: GreaterThan
GreaterThanOrEqual: GreaterThanOrEqual
LessThan: LessThan
LessThanOrEqual: LessThanOrEqual

PredictiveAutoscalePolicyScaleMode

the predictive autoscale mode

PrivateEndpointConnectionProvisioningState

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Connection has been provisioned
Creating: Connection is being created
Deleting: Connection is being deleted
Failed: Connection provisioning has failed

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

PrivateLinkScopeProvisioningState

Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
KnownPrivateLinkScopeProvisioningState can be used interchangeably with PrivateLinkScopeProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Failed: Failed
Deleting: Deleting
Canceled: Canceled

ReceiverStatus

Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications.

RecurrenceFrequency

the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set schedule to every day of the week. The frequency property specifies that the schedule is repeated weekly.

ResourceAssociationAccessMode

Access mode of the resource association
KnownResourceAssociationAccessMode can be used interchangeably with ResourceAssociationAccessMode, this enum contains the known values that the service supports.

Known values supported by the service

Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked

ResultType

Type of ResultType

ScaleDirection

the scale direction. Whether the scaling action increases or decreases the number of instances.

ScaleRuleMetricDimensionOperationType

the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values
KnownScaleRuleMetricDimensionOperationType can be used interchangeably with ScaleRuleMetricDimensionOperationType, this enum contains the known values that the service supports.

Known values supported by the service

Equals: Equals
NotEquals: NotEquals

ScaleType

the type of action that should occur when the scale rule fires.

ScopedResourceKind

The kind of scoped Azure monitor resource.
KnownScopedResourceKind can be used interchangeably with ScopedResourceKind, this enum contains the known values that the service supports.

Known values supported by the service

Resource: Resource
Metrics: Metrics

ScopedResourceProvisioningState

State of the Azure monitor resource.
KnownScopedResourceProvisioningState can be used interchangeably with ScopedResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Provisioning: Provisioning
Failed: Failed
Canceled: Canceled

Severity

Severity of the issue.
KnownSeverity can be used interchangeably with Severity, this enum contains the known values that the service supports.

Known values supported by the service

Warning: The issue is a warning and does not prevent the configuration from being applied.
Error: The issue is an error and prevents the configuration from being applied.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

TimeAggregation

Aggregation type. Relevant and required only for rules of the kind LogAlert.
KnownTimeAggregation can be used interchangeably with TimeAggregation, this enum contains the known values that the service supports.

Known values supported by the service

Count: Count
Average: Average
Minimum: Minimum
Maximum: Maximum
Total: Total

TimeAggregationType

time aggregation type. How the data that is collected should be combined over time. The default value is Average.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAccessMode

Access mode types.

KnownAccessRuleDirection

Direction of Access Rule

KnownAggregationTypeEnum

The criteria time aggregation types. Previously undocumented values might be returned

KnownAlertSeverity

Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.

KnownBaselineSensitivity

the sensitivity of the baseline.

KnownCategoryType

The type of the diagnostic settings category.

KnownConditionOperator

The criteria operator. Relevant and required only for rules of the kind LogAlert.

KnownCreatedByType

The kind of entity that created the resource.

KnownCriterionType

Specifies the type of threshold criteria. Previously undocumented values might be returned

KnownDataStatus

The status of VM Insights data from the resource. When reported as present the data array will contain information about the data containers to which data for the specified resource is being routed.

KnownDimensionOperator

Operator for dimension values

KnownDynamicThresholdOperator

The operator used to compare the metric value against the threshold. Previously undocumented values might be returned

KnownDynamicThresholdSensitivity

The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. Previously undocumented values might be returned

KnownIncidentManagementService

The incident management service type

KnownIssueType

Type of issue

KnownKind

Indicates the type of scheduled query rule. The default is LogAlert.

KnownKnownAgentSettingName

The name of the setting. Must be part of the list of supported settings

KnownKnownColumnDefinitionType

The type of the column data.

KnownKnownDataCollectionEndpointProvisioningState

The resource provisioning state. This property is READ-ONLY.

KnownKnownDataCollectionEndpointResourceKind

The kind of the resource.

KnownKnownDataCollectionRuleAssociationProvisioningState

The resource provisioning state.

KnownKnownDataCollectionRuleProvisioningState

The resource provisioning state.

KnownKnownDataCollectionRuleResourceKind

The kind of the resource.

KnownKnownDataFlowStreams

Known values of KnownDataFlowStreams that the service accepts.

KnownKnownEtwProviderDataSourceLogLevel

Minimal level of detail to be logged

KnownKnownEtwProviderType

Provider type specification: By Manifest GUID or by Event Source name

KnownKnownExtensionDataSourceStreams

Known values of KnownExtensionDataSourceStreams that the service accepts.

KnownKnownLocationSpecProvisioningStatus

The resource provisioning state in this location.

KnownKnownLogFileTextSettingsRecordStartTimestampFormat

One of the supported timestamp formats

KnownKnownLogFilesDataSourceFormat

The data format of the log files

KnownKnownOtelLogsDataSourceStreams

Known values of KnownOtelLogsDataSourceStreams that the service accepts.

KnownKnownOtelLogsDirectDataSourceStreams

Known values of KnownOtelLogsDirectDataSourceStreams that the service accepts.

KnownKnownOtelTracesDataSourceStreams

Known values of KnownOtelTracesDataSourceStreams that the service accepts.

KnownKnownOtelTracesDirectDataSourceStreams

Known values of KnownOtelTracesDirectDataSourceStreams that the service accepts.

KnownKnownPerfCounterDataSourceStreams

Known values of KnownPerfCounterDataSourceStreams that the service accepts.

KnownKnownPerformanceCountersOTelDataSourceStreams

Known values of KnownPerformanceCountersOTelDataSourceStreams that the service accepts.

KnownKnownPrometheusForwarderDataSourceStreams

Known values of KnownPrometheusForwarderDataSourceStreams that the service accepts.

KnownKnownPublicNetworkAccessOptions

The configuration to set whether network access from public internet to the endpoints are allowed.

KnownKnownStorageBlobLookupType

The type of lookup to perform on the blob

KnownKnownSyslogDataSourceFacilityNames

Known values of KnownSyslogDataSourceFacilityNames that the service accepts.

KnownKnownSyslogDataSourceLogLevels

Known values of KnownSyslogDataSourceLogLevels that the service accepts.

KnownKnownSyslogDataSourceStreams

Known values of KnownSyslogDataSourceStreams that the service accepts.

KnownKnownWindowsEventLogDataSourceStreams

Known values of KnownWindowsEventLogDataSourceStreams that the service accepts.

KnownKnownWindowsFirewallLogsDataSourceProfileFilter

Known values of KnownWindowsFirewallLogsDataSourceProfileFilter that the service accepts.

KnownManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

KnownMetricAggregationType

The aggregation type of the metric.

KnownMetricClass

The class of the metric.

KnownMetricResultType

Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.

KnownMetricUnit

The unit of the metric.

KnownNamespaceClassification

Kind of namespace

KnownNetworkSecurityPerimeterConfigurationProvisioningState

Provisioning state of a network security perimeter configuration that is being created or updated.

KnownOdatatype

Specifies the type of the alert criteria. Previously undocumented values might be returned

KnownOnboardingStatus

The onboarding status for the resource. Note that, a higher level scope, e.g., resource group or subscription, is considered onboarded if at least one resource under it is onboarded.

KnownOperator

The criteria operator. Previously undocumented values might be returned

KnownPrivateEndpointConnectionProvisioningState

The current provisioning state.

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownPrivateLinkScopeProvisioningState

Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.

KnownResourceAssociationAccessMode

Access mode of the resource association

KnownScaleRuleMetricDimensionOperationType

the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values

KnownScopedResourceKind

The kind of scoped Azure monitor resource.

KnownScopedResourceProvisioningState

State of the Azure monitor resource.

KnownSeverity

Severity of the issue.

KnownTimeAggregation

Aggregation type. Relevant and required only for rules of the kind LogAlert.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(MonitorClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(MonitorClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: MonitorClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client
MonitorClient
serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type