@azure/arm-monitorworkspaces package

Classes

Interfaces

AzureMonitorWorkspace	Properties of an Azure Monitor Workspace
AzureMonitorWorkspaceDefaultIngestionSettings	The Data Collection Rule and Endpoint used for ingestion by default.
AzureMonitorWorkspaceMetrics	Properties related to the metrics container in the Azure Monitor Workspace
AzureMonitorWorkspaceResource	An Azure Monitor Workspace definition
AzureMonitorWorkspaceResourceUpdate	The type used for updating an Azure Monitor Workspace
AzureMonitorWorkspacesCreateOrUpdateOptionalParams	Optional parameters.
AzureMonitorWorkspacesDeleteOptionalParams	Optional parameters.
AzureMonitorWorkspacesGetOptionalParams	Optional parameters.
AzureMonitorWorkspacesListByResourceGroupOptionalParams	Optional parameters.
AzureMonitorWorkspacesListBySubscriptionOptionalParams	Optional parameters.
AzureMonitorWorkspacesOperations	Interface representing a AzureMonitorWorkspaces operations.
AzureMonitorWorkspacesUpdateOptionalParams	Optional parameters.
Background	The issue background information
BackgroundDetails	A background details element
BackgroundVisualization	The issue background visualization
BackgroundVisualizationCreate	Background visualization for write operations, omitting the server-side read-only 'origin' field.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FetchInvestigationResultParameters	Parameters provided to get the investigation result
IngestionEndpoints	The ingestion endpoints for an Azure Monitor Workspace.
InvestigationMetadata	Properties of the current investigation
InvestigationResult	Details about the investigation result
IssueAddInvestigationResultOptionalParams	Optional parameters.
IssueAddOrUpdateAlertsOptionalParams	Optional parameters.
IssueAddOrUpdateResourcesOptionalParams	Optional parameters.
IssueCreateOptionalParams	Optional parameters.
IssueCreationNotificationType	Notification type for issue creation events
IssueDeleteOptionalParams	Optional parameters.
IssueFetchBackgroundVisualizationOptionalParams	Optional parameters.
IssueFetchInvestigationResultOptionalParams	Optional parameters.
IssueGetOptionalParams	Optional parameters.
IssueListAlertsOptionalParams	Optional parameters.
IssueListOptionalParams	Optional parameters.
IssueListResourcesOptionalParams	Optional parameters.
IssueNotificationType	Base properties for an issue notification type
IssueOperations	Interface representing a Issue operations.
IssuePayloadCreate	Issue properties for create/update operations, omitting server-side read-only fields (investigations, investigationsCount, provisioningState).
IssueProperties	The issue properties
IssuePropertiesUpdate	The issue properties for update
IssueResource	The Issue resource
IssueResourceCreate	Issue resource for create/update operations.
IssueResourceUpdate	The Issue resource update
IssueSetBackgroundVisualizationOptionalParams	Optional parameters.
IssueUpdateOptionalParams	Optional parameters.
ListParameter	Parameters for listing related entities
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MetricsContainer	Properties of a metrics container.
MetricsContainerResource	Metrics container resource for an Azure Monitor Workspace.
MetricsContainersCreateOrUpdateOptionalParams	Optional parameters.
MetricsContainersGetOptionalParams	Optional parameters.
MetricsContainersListByAzureMonitorWorkspaceOptionalParams	Optional parameters.
MetricsContainersOperations	Interface representing a MetricsContainers operations.
MonitorClientOptionalParams	Optional parameters for the client.
Notifications	Issue notification settings
OnChangeNotificationType	Notification type for on-change events
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
Origin	Details about the origin of the entity - the source that added it to the issue
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagedRelatedAlert	Paged collection of RelatedAlert items
PagedRelatedResource	Paged collection of RelatedResource items
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RelatedAlert	Properties of an alert which is related to the issue
RelatedAlertCreate	Properties of an alert related to the issue for write operations, omitting server-side read-only fields (origin, addedAt, lastModifiedAt).
RelatedAlerts	A list of related alerts
RelatedAlertsCreate	A list of related alerts for write operations.
RelatedResource	Properties of a resource which is related to the issue
RelatedResourceCreate	Properties of a resource related to the issue for write operations, omitting server-side read-only fields (origin, addedAt, lastModifiedAt).
RelatedResources	A list of related resources
RelatedResourcesCreate	A list of related resources for write operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SystemData	Metadata pertaining to creation and last modification of the resource.
TimeBasedUpdatesNotificationType	Notification type for time-based updates
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

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AddedByType	The type of entity that added data to the issue KnownAddedByType can be used interchangeably with AddedByType, this enum contains the known values that the service supports. Known values supported by the service Manual: The data was added manually by a user Automatic: The data was added automatically
ArmOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownArmOrigin can be used interchangeably with ArmOrigin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
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.
IssueNotificationTypeUnion	Alias for IssueNotificationTypeUnion
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.
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
PublicNetworkAccess	Gets or sets allow or disallow public network access to Azure Monitor Workspace KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled: Public network access is enabled. Disabled: Public network access is disabled.
Relevance	The relevance status of the resource KnownRelevance can be used interchangeably with Relevance, this enum contains the known values that the service supports. Known values supported by the service None: No relevance status for the resource Relevant: The resource is relevant to the issue Irrelevant: The resource is irrelevant to the issue
ResourceProvisioningState	The provisioning state of a resource type. KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled.
Status	The issue status KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service New: The issue is new InProgress: The issue is in progress Mitigated: The issue is mitigated Closed: The issue is closed Canceled: The issue is canceled
UpdateType	The type of update that triggers a notification KnownUpdateType can be used interchangeably with UpdateType, this enum contains the known values that the service supports. Known values supported by the service IssueCreation: Notification sent when an issue is created TimeBased: Notification sent based on time intervals OnChange: Notification sent when the issue changes

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAddedByType	The type of entity that added data to the issue
KnownArmOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownCreatedByType	The kind of entity that created the resource.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownPublicNetworkAccess	Gets or sets allow or disallow public network access to Azure Monitor Workspace
KnownRelevance	The relevance status of the resource
KnownResourceProvisioningState	The provisioning state of a resource type.
KnownStatus	The issue status
KnownUpdateType	The type of update that triggers a notification
KnownVersions	The available API versions.

Functions

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.

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>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

@azure/arm-monitorworkspaces package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

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

Parameters

Returns

Feedback