@azure/arm-operationalinsights package

Access rule in a network security perimeter configuration profile

Properties of Access Rule

we add this model in order to replace subscriptions model in CommonTypes with this model via alternateType decorator

The list of Log Analytics workspaces associated with the cluster.

Service Tier details.

Optional parameters.

Interface representing a AvailableServiceTiers operations.

The resource model definition for an Azure Resource Manager resource with an etag.

The Capacity Reservation properties.

The top level Log Analytics cluster resource container.

The top level Log Analytics cluster resource container.

Log Analytics cluster patch properties.

Cluster properties.

Cluster replication properties.

The cluster sku definition.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Clusters operations.

Optional parameters.

Table column.

The core summary of a search.

The top level data export resource container.

Data Export properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DataExports operations.

Datasources under OMS Workspace.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a DataSources operations.

Optional parameters.

Optional parameters.

Interface representing a DeletedWorkspaces operations.

Destination properties.

Destination meta data.

The resource management error additional info.

The error detail.

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

Optional parameters.

Interface representing a Gateways operations.

Identity for the resource.

Intelligence Pack containing a string name and boolean indicating if it's enabled.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a IntelligencePacks operations.

The key vault properties.

The top level Linked service resource container.

Linked service properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a LinkedServices operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a LinkedStorageAccounts operations.

Linked storage accounts properties.

Linked storage accounts top level resource container.

An Log Analytics QueryPack definition.

Properties that define a Log Analytics QueryPack resource.

A Log Analytics QueryPack-Query definition.

Properties that define an Log Analytics QueryPack-Query resource.

The related metadata items for the function.

Properties that define an Log Analytics QueryPack-Query search properties.

The related metadata items for the function.

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

A management group that is connected to a workspace

Management group properties.

Optional parameters.

Interface representing a ManagementGroups operations.

The name of a metric.

Information about a network security perimeter (NSP)

Network security perimeter (NSP) configuration resource

Network security configuration properties.

Network security perimeter configuration profile

Supported operation of OperationalInsights resource provider.

Display metadata associated with the operation.

The status of operation.

Optional parameters.

Interface representing a OperationStatuses operations.

Optional parameters for the client.

Optional parameters.

Interface representing a Operations operations.

Options for the byPage method

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

The private link scope resource reference.

Describes a provisioning issue for a network security perimeter configuration

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

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

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Queries operations.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a QueryPacks operations.

Optional parameters.

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

Information about resource association

Restore parameters.

Search job execution statistics.

Rule definition parameters.

Value object for saved search results.

Value object for saved search results.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

The saved search list operation response.

Interface representing a SavedSearches operations.

Table's schema.

Optional parameters.

Interface representing a Schema operations.

The get schema operation response.

Metadata for search results.

Schema metadata for search.

Parameters of the search job that initiated this table.

Value object for schema results.

The sort parameters for search.

The shared keys for a workspace.

Optional parameters.

Interface representing a SharedKeys operations.

Optional parameters.

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

Describes a storage account connection.

The top level storage insight resource container.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a StorageInsightConfigs operations.

Storage insight properties.

The status of the storage insight.

Workspace data summary rules definition.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a SummaryLogs operations.

Summary rule properties.

Request to retry a summary logs bin.

Optional parameters.

Properties for retrying a Summary rule bin.

Optional parameters.

Optional parameters.

Metadata pertaining to creation and last modification of the resource.

Workspace data table definition.

Table properties.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Tables operations.

Optional parameters.

A tag of a saved search.

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

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

A metric describing the usage of a resource.

Optional parameters.

Interface representing a Usages operations.

User assigned identity properties

User assigned identity properties.

The top level Workspace resource container.

The daily volume cap for ingestion.

The failover state of the replication.

Workspace features.

The top level Workspace resource container.

Workspace properties.

Describes the body of a purge request for an App Insights Workspace

User-defined filters to return data which will be purged from the table.

Optional parameters.

Interface representing a WorkspacePurge operations.

Optional parameters.

Response containing operationId for a specific purge action.

Response containing status for a specific purge operation.

Workspace replication properties.

The SKU (tier) of a workspace.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Interface representing a Workspaces operations.

Optional parameters.

Optional parameters.

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

The supported values for cloud setting as a string literal type

Configures whether billing will be only on the cluster or each workspace will be billed by its proportional use. This does not change the overall billing, only how it will be distributed. Default value is 'Cluster'
KnownBillingType can be used interchangeably with BillingType, this enum contains the known values that the service supports.

Known values supported by the service

Cluster: Cluster
Workspaces: Workspaces

The provisioning state of the cluster.
KnownClusterEntityStatus can be used interchangeably with ClusterEntityStatus, this enum contains the known values that the service supports.

Known values supported by the service

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

The provisioning state of the cluster replication.
KnownClusterReplicationState can be used interchangeably with ClusterReplicationState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
EnableRequested: EnableRequested
Enabling: Enabling
DisableRequested: DisableRequested
Disabling: Disabling
RollbackRequested: RollbackRequested
RollingBack: RollingBack
Failed: Failed
Canceled: Canceled

The SKU (tier) of a cluster.
KnownClusterSkuNameEnum can be used interchangeably with ClusterSkuNameEnum, this enum contains the known values that the service supports.

Known values supported by the service

CapacityReservation: CapacityReservation

Column data type logical hint.
KnownColumnDataTypeHintEnum can be used interchangeably with ColumnDataTypeHintEnum, this enum contains the known values that the service supports.

Known values supported by the service

uri: A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment
guid: A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
armPath: An Azure Resource Model (ARM) path: /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft.{...}/{...}/{...}/{...}...
ip: A standard V4/V6 ip address following the standard shape, x.x.x.x/y:y:y:y:y:y:y:y

Column data type.
KnownColumnTypeEnum can be used interchangeably with ColumnTypeEnum, 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
guid: guid
dynamic: dynamic

An interface that describes a page of results.

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.

The status of data ingestion for this workspace.
KnownDataIngestionStatus can be used interchangeably with DataIngestionStatus, this enum contains the known values that the service supports.

Known values supported by the service

RespectQuota: Ingestion enabled following daily cap quota reset, or subscription enablement.
ForceOn: Ingestion started following service setting change.
ForceOff: Ingestion stopped following service setting change.
OverQuota: Reached daily cap quota, ingestion stopped.
SubscriptionSuspended: Ingestion stopped following suspended subscription.
ApproachingQuota: 80% of daily cap quota reached.

The kind of the DataSource.
KnownDataSourceKind can be used interchangeably with DataSourceKind, this enum contains the known values that the service supports.

Known values supported by the service

WindowsEvent: WindowsEvent
WindowsPerformanceCounter: WindowsPerformanceCounter
IISLogs: IISLogs
LinuxSyslog: LinuxSyslog
LinuxSyslogCollection: LinuxSyslogCollection
LinuxPerformanceObject: LinuxPerformanceObject
LinuxPerformanceCollection: LinuxPerformanceCollection
CustomLog: CustomLog
CustomLogCollection: CustomLogCollection
AzureAuditLog: AzureAuditLog
AzureActivityLog: AzureActivityLog
GenericDataSource: GenericDataSource
ChangeTrackingCustomPath: ChangeTrackingCustomPath
ChangeTrackingPath: ChangeTrackingPath
ChangeTrackingServices: ChangeTrackingServices
ChangeTrackingDataTypeConfiguration: ChangeTrackingDataTypeConfiguration
ChangeTrackingDefaultRegistry: ChangeTrackingDefaultRegistry
ChangeTrackingRegistry: ChangeTrackingRegistry
ChangeTrackingLinuxPath: ChangeTrackingLinuxPath
LinuxChangeTrackingPath: LinuxChangeTrackingPath
ChangeTrackingContentLocation: ChangeTrackingContentLocation
WindowsTelemetry: WindowsTelemetry
Office365: Office365
SecurityWindowsBaselineConfiguration: SecurityWindowsBaselineConfiguration
SecurityCenterSecurityWindowsBaselineConfiguration: SecurityCenterSecurityWindowsBaselineConfiguration
SecurityEventCollectionConfiguration: SecurityEventCollectionConfiguration
SecurityInsightsSecurityEventCollectionConfiguration: SecurityInsightsSecurityEventCollectionConfiguration
ImportComputerGroup: ImportComputerGroup
NetworkMonitoring: NetworkMonitoring
Itsm: Itsm
DnsAnalytics: DnsAnalytics
ApplicationInsights: ApplicationInsights
SqlDataClassification: SqlDataClassification

Linked storage accounts type.

Type of managed service identity.

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.

The provisioning state of the linked service.
KnownLinkedServiceEntityStatus can be used interchangeably with LinkedServiceEntityStatus, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
Deleting: Deleting
ProvisioningAccount: ProvisioningAccount
Updating: Updating

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.

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
Creating
Updating
Deleting
Accepted
Failed
Canceled

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
KnownOperationalInsightsTableProvisioningState can be used interchangeably with OperationalInsightsTableProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done.
InProgress: Table schema is stable and without changes, table data is being updated.
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates.
Deleting: Table state is deleting.

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
KnownProvisioningStateEnum can be used interchangeably with ProvisioningStateEnum, this enum contains the known values that the service supports.

Known values supported by the service

Updating: Table schema is still being built and updated, table is currently locked for any changes till the procedure is done.
Succeeded: Table state is stable and without changes, table is unlocked and open for new updates.
Deleting: Table state is deleting.
Failed: Table state is failed.
Canceled: Table state is canceled.

The network access type for operating on the Log Analytics Workspace. By default it is Enabled
KnownPublicNetworkAccessType can be used interchangeably with PublicNetworkAccessType, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Enables connectivity to Log Analytics through public DNS.
Disabled: Disables public connectivity to Log Analytics through public DNS.
SecuredByPerimeter: Resource is only accessible from private networks and access approved by network security perimeter associated to this resource.

Status of the operation represented by the requested Id.
KnownPurgeState can be used interchangeably with PurgeState, this enum contains the known values that the service supports.

Known values supported by the service

pending: pending
completed: completed

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

SummaryRules rule type: User.
KnownRuleTypeEnum can be used interchangeably with RuleTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

User: User defined summary rule. This is the definition for rules created and defined by users.

The sort order of the search.
KnownSearchSortEnum can be used interchangeably with SearchSortEnum, this enum contains the known values that the service supports.

Known values supported by the service

asc: asc
desc: desc

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
Error

The name of the Service Tier.
KnownSkuNameEnum can be used interchangeably with SkuNameEnum, this enum contains the known values that the service supports.

Known values supported by the service

Free: Free
Standard: Standard
Premium: Premium
PerNode: PerNode
PerGB2018: PerGB2018
Standalone: Standalone
CapacityReservation: CapacityReservation

Table's creator.
KnownSourceEnum can be used interchangeably with SourceEnum, this enum contains the known values that the service supports.

Known values supported by the service

microsoft: Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means.
customer: Tables created by the owner of the Workspace, and only found in this Workspace.

Indicates the reason for rule deactivation.
KnownStatusCodeEnum can be used interchangeably with StatusCodeEnum, this enum contains the known values that the service supports.

Known values supported by the service

UserAction: Summary rule stop originated from a user action (Stop was called).
DataPlaneError: Summary rule stop was caused due to data plane related error.

The state of the storage insight connection to the workspace
KnownStorageInsightState can be used interchangeably with StorageInsightState, this enum contains the known values that the service supports.

Known values supported by the service

OK: OK
ERROR: ERROR

Instruct the system how to handle and charge the logs ingested to this table.
KnownTablePlanEnum can be used interchangeably with TablePlanEnum, this enum contains the known values that the service supports.

Known values supported by the service

Basic: Medium-touch logs needed for troubleshooting and incident response.
Analytics: High-value logs used for continuous monitoring, real-time detection, and performance analytics.
Auxiliary: Low-touch logs, such as verbose logs, and data required for auditing and compliance.

The subtype describes what APIs can be used to interact with the table, and what features are available against it.
KnownTableSubTypeEnum can be used interchangeably with TableSubTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Any: The default subtype with which built-in tables are created.
Classic: Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created.
DataCollectionRuleBased: A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules

Table's creator.
KnownTableTypeEnum can be used interchangeably with TableTypeEnum, this enum contains the known values that the service supports.

Known values supported by the service

Microsoft: Standard data collected by Azure Monitor.
CustomLog: Custom log table.
RestoredLogs: Restored data.
SearchResults: Data collected by a search job.

The time cursor used in Summary rules bins processing, e.g. TimeGenerated.
KnownTimeSelectorEnum can be used interchangeably with TimeSelectorEnum, this enum contains the known values that the service supports.

Known values supported by the service

TimeGenerated: TimeGenerated.

The type of the destination resource
KnownType can be used interchangeably with Type, this enum contains the known values that the service supports.

Known values supported by the service

StorageAccount: StorageAccount
EventHub: EventHub

The provisioning state of the workspace.
KnownWorkspaceEntityStatus can be used interchangeably with WorkspaceEntityStatus, this enum contains the known values that the service supports.

Known values supported by the service

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

The failover state of the replication.
KnownWorkspaceFailoverState can be used interchangeably with WorkspaceFailoverState, this enum contains the known values that the service supports.

Known values supported by the service

Inactive: Inactive
Activating: Activating
Active: Active
Deactivating: Deactivating
Failed: Failed

The provisioning state of the replication.
KnownWorkspaceReplicationState can be used interchangeably with WorkspaceReplicationState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Succeeded
EnableRequested: EnableRequested
Enabling: Enabling
DisableRequested: DisableRequested
Disabling: Disabling
RollbackRequested: RollbackRequested
RollingBack: RollingBack
Failed: Failed
Canceled: Canceled

The name of the SKU.
KnownWorkspaceSkuNameEnum can be used interchangeably with WorkspaceSkuNameEnum, this enum contains the known values that the service supports.

Known values supported by the service

Free: Free
Standard: Standard
Premium: Premium
PerNode: PerNode
PerGB2018: PerGB2018
Standalone: Standalone
CapacityReservation: CapacityReservation
LACluster: LACluster

An enum to describe Azure Cloud environments.

Direction of Access Rule

Configures whether billing will be only on the cluster or each workspace will be billed by its proportional use. This does not change the overall billing, only how it will be distributed. Default value is 'Cluster'

The provisioning state of the cluster.

The provisioning state of the cluster replication.

The SKU (tier) of a cluster.

Column data type logical hint.

Column data type.

The kind of entity that created the resource.

The status of data ingestion for this workspace.

The kind of the DataSource.

Type of issue

The provisioning state of the linked service.

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

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

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.

Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.

The network access type for operating on the Log Analytics Workspace. By default it is Enabled

Status of the operation represented by the requested Id.

Access mode of the resource association

SummaryRules rule type: User.

The sort order of the search.

Severity of the issue.

The name of the Service Tier.

Table's creator.

Indicates the reason for rule deactivation.

The state of the storage insight connection to the workspace

Instruct the system how to handle and charge the logs ingested to this table.

The subtype describes what APIs can be used to interact with the table, and what features are available against it.

Table's creator.

The time cursor used in Summary rules bins processing, e.g. TimeGenerated.

The type of the destination resource

The available API versions.

The provisioning state of the workspace.

The failover state of the replication.

The provisioning state of the replication.

The name of the SKU.

Typeguard for RestError

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.

A custom error type for failed pipeline requests.