@azure/arm-dynatrace package

Classes

DynatraceObservability

Interfaces

AccountInfo	Dynatrace Account Information
AppServiceInfo	Details of App Services having Dynatrace OneAgent installed
ConnectedResourcesCountResponse	Response for getting Connected resources for a MP SaaS Resource
CreateResourceSupportedProperties	Properties related to the support for creating Dynatrace resources.
CreateResourceSupportedResponse	Dynatrace resource can be created or not.
CreationSupportedGetOptionalParams	Optional parameters.
CreationSupportedListOptionalParams	Optional parameters.
CreationSupportedOperations	Interface representing a CreationSupported operations.
DynatraceEnvironmentProperties	Properties of the Dynatrace environment.
DynatraceObservabilityOptionalParams	Optional parameters for the client.
DynatraceSingleSignOnProperties	The details of a Dynatrace single sign-on.
DynatraceSingleSignOnResource	Single sign-on configurations for a given monitor resource.
EnvironmentInfo	Dynatrace Environment Information
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.
FilteringTag	The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.
IdentityProperties	The properties of the managed service identities assigned to this resource.
LinkableEnvironmentRequest	Request for getting all the linkable environments for a user
LinkableEnvironmentResponse	Response for getting all the linkable environments
LogRules	Set of rules for sending logs for the Monitor resource.
LogStatusRequest	Request for getting log status for given monitored resource Ids
ManageAgentInstallationRequest	Request for performing Dynatrace agent install/uninstall action through the Azure Dynatrace resource on the provided list of agent resources.
ManageAgentList	Details of resource that has Dynatrace agent installed through the Azure Dynatrace resource.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MarketplaceSaaSResourceDetailsRequest	Request for getting Marketplace SaaS resource details for a tenant Id
MarketplaceSaaSResourceDetailsResponse	Marketplace SaaS resource details linked to the given tenant Id
MarketplaceSubscriptionIdRequest	Request for getting connected resources count for a Marketplace Subscription Id
MetricRules	Set of rules for sending metrics for the Monitor resource.
MetricStatusRequest	Request for getting metric status for given monitored resource Ids
MetricsStatusResponse	Response of get metrics status operation
MonitorProperties	Properties specific to the monitor resource.
MonitorResource	Dynatrace Monitor Resource
MonitorResourceUpdate	The updatable properties of the MonitorResource.
MonitorUpdateProperties	The set of properties that can be updated in a PATCH request to a monitor resource.
MonitoredResource	Details of resource being monitored by Dynatrace monitor resource
MonitoredSubscription	The list of subscriptions and it's monitoring status by current Dynatrace monitor.
MonitoredSubscriptionProperties	The request to update subscriptions needed to be monitored by the Dynatrace monitor resource.
MonitoredSubscriptionsCreateOrUpdateOptionalParams	Optional parameters.
MonitoredSubscriptionsDeleteOptionalParams	Optional parameters.
MonitoredSubscriptionsGetOptionalParams	Optional parameters.
MonitoredSubscriptionsListOptionalParams	Optional parameters.
MonitoredSubscriptionsOperations	Interface representing a MonitoredSubscriptions operations.
MonitoredSubscriptionsUpdateOptionalParams	Optional parameters.
MonitoringTagRulesProperties	Properties for the Tag rules resource of a Monitor account.
MonitorsCreateOrUpdateOptionalParams	Optional parameters.
MonitorsDeleteOptionalParams	Optional parameters.
MonitorsGetAllConnectedResourcesCountOptionalParams	Optional parameters.
MonitorsGetMarketplaceSaaSResourceDetailsOptionalParams	Optional parameters.
MonitorsGetMetricStatusOptionalParams	Optional parameters.
MonitorsGetOptionalParams	Optional parameters.
MonitorsGetSSODetailsOptionalParams	Optional parameters.
MonitorsGetVMHostPayloadOptionalParams	Optional parameters.
MonitorsListAppServicesOptionalParams	Optional parameters.
MonitorsListByResourceGroupOptionalParams	Optional parameters.
MonitorsListBySubscriptionIdOptionalParams	Optional parameters.
MonitorsListHostsOptionalParams	Optional parameters.
MonitorsListLinkableEnvironmentsOptionalParams	Optional parameters.
MonitorsListMonitoredResourcesOptionalParams	Optional parameters.
MonitorsManageAgentInstallationOptionalParams	Optional parameters.
MonitorsOperations	Interface representing a Monitors operations.
MonitorsUpdateOptionalParams	Optional parameters.
MonitorsUpgradePlanOptionalParams	Optional parameters.
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.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PlanData	Billing plan information.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SSODetailsRequest	Request for getting sso details for a user
SSODetailsResponse	SSO details from the Dynatrace partner
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SingleSignOnCreateOrUpdateOptionalParams	Optional parameters.
SingleSignOnGetOptionalParams	Optional parameters.
SingleSignOnListOptionalParams	Optional parameters.
SingleSignOnOperations	Interface representing a SingleSignOn operations.
SubscriptionList	The request to update subscriptions needed to be monitored by the Dynatrace monitor resource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagRule	Tag rules for a monitor resource
TagRulesCreateOrUpdateOptionalParams	Optional parameters.
TagRulesDeleteOptionalParams	Optional parameters.
TagRulesGetOptionalParams	Optional parameters.
TagRulesListOptionalParams	Optional parameters.
TagRulesOperations	Interface representing a TagRules operations.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UpgradePlanRequest	The billing plan properties for the upgrade plan call.
UserAssignedIdentity	User assigned identity properties
UserInfo	User info.
VMExtensionPayload	Response of payload to be passed while installing VM agent.
VMInfo	Details of VM Resource having Dynatrace OneAgent installed

Type Aliases

Action	Install/Uninstall action. KnownAction can be used interchangeably with Action, this enum contains the known values that the service supports. Known values supported by the service Install Uninstall
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.
AutoUpdateSetting	Update settings of OneAgent. KnownAutoUpdateSetting can be used interchangeably with AutoUpdateSetting, this enum contains the known values that the service supports. Known values supported by the service ENABLED DISABLED
AvailabilityState	The availability state of OneAgent. KnownAvailabilityState can be used interchangeably with AvailabilityState, this enum contains the known values that the service supports. Known values supported by the service CRASHED LOST MONITORED PRE_MONITORED SHUTDOWN UNEXPECTED_SHUTDOWN UNKNOWN UNMONITORED
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.
LiftrResourceCategories	Liftr resource category KnownLiftrResourceCategories can be used interchangeably with LiftrResourceCategories, this enum contains the known values that the service supports. Known values supported by the service Unknown MonitorLogs
LogModule	Tells whether log modules are enabled or not KnownLogModule can be used interchangeably with LogModule, this enum contains the known values that the service supports. Known values supported by the service ENABLED DISABLED
ManagedIdentityType	The kind of managed identity assigned to this resource. KnownManagedIdentityType can be used interchangeably with ManagedIdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned UserAssigned SystemAndUserAssigned
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.
MarketplaceSaasAutoRenew	Marketplace resource autorenew flag KnownMarketplaceSaasAutoRenew can be used interchangeably with MarketplaceSaasAutoRenew, this enum contains the known values that the service supports. Known values supported by the service On Off
MarketplaceSubscriptionStatus	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. KnownMarketplaceSubscriptionStatus can be used interchangeably with MarketplaceSubscriptionStatus, this enum contains the known values that the service supports. Known values supported by the service Active Suspended Unsubscribed
MonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled. KnownMonitoringStatus can be used interchangeably with MonitoringStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
MonitoringType	The monitoring mode of OneAgent KnownMonitoringType can be used interchangeably with MonitoringType, this enum contains the known values that the service supports. Known values supported by the service CLOUD_INFRASTRUCTURE FULL_STACK DISCOVERY
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, 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.
ProvisioningState	Provisioning state of the monitoring resource KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Updating Deleting Succeeded Failed Canceled Deleted NotSpecified
SSOStatus	Indicates whether SSO is enabled or not KnownSSOStatus can be used interchangeably with SSOStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
SendAadLogsStatus	Indicates whether AAD logs are being sent. KnownSendAadLogsStatus can be used interchangeably with SendAadLogsStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
SendActivityLogsStatus	Indicates whether activity logs are being sent. KnownSendActivityLogsStatus can be used interchangeably with SendActivityLogsStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
SendSubscriptionLogsStatus	Indicates whether subscription logs are being sent. KnownSendSubscriptionLogsStatus can be used interchangeably with SendSubscriptionLogsStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
SendingLogsStatus	Indicates whether logs are being sent. KnownSendingLogsStatus can be used interchangeably with SendingLogsStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
SendingMetricsStatus	Indicates whether metrics are being sent. KnownSendingMetricsStatus can be used interchangeably with SendingMetricsStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
SingleSignOnStates	Various states of the SSO resource KnownSingleSignOnStates can be used interchangeably with SingleSignOnStates, this enum contains the known values that the service supports. Known values supported by the service Initial Enable Disable Existing
Status	The state of monitoring. KnownStatus can be used interchangeably with Status, this enum contains the known values that the service supports. Known values supported by the service InProgress Active Failed Deleting
SubscriptionListOperation	The operation for the patch on the resource. KnownSubscriptionListOperation can be used interchangeably with SubscriptionListOperation, this enum contains the known values that the service supports. Known values supported by the service AddBegin AddComplete DeleteBegin DeleteComplete Active
TagAction	Valid actions for a filtering tag. Exclusion takes priority over inclusion. KnownTagAction can be used interchangeably with TagAction, this enum contains the known values that the service supports. Known values supported by the service Include Exclude
UpdateStatus	The current update status of OneAgent. KnownUpdateStatus can be used interchangeably with UpdateStatus, this enum contains the known values that the service supports. Known values supported by the service INCOMPATIBLE OUTDATED SCHEDULED SUPPRESSED UNKNOWN UP2DATE UPDATE_IN_PROGRESS UPDATE_PENDING UPDATE_PROBLEM

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAction	Install/Uninstall action.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAutoUpdateSetting	Update settings of OneAgent.
KnownAvailabilityState	The availability state of OneAgent.
KnownCreatedByType	The kind of entity that created the resource.
KnownLiftrResourceCategories	Liftr resource category
KnownLogModule	Tells whether log modules are enabled or not
KnownManagedIdentityType	The kind of managed identity assigned to this resource.
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMarketplaceSaasAutoRenew	Marketplace resource autorenew flag
KnownMarketplaceSubscriptionStatus	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.
KnownMonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled.
KnownMonitoringType	The monitoring mode of OneAgent
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	Provisioning state of the monitoring resource
KnownSSOStatus	Indicates whether SSO is enabled or not
KnownSendAadLogsStatus	Indicates whether AAD logs are being sent.
KnownSendActivityLogsStatus	Indicates whether activity logs are being sent.
KnownSendSubscriptionLogsStatus	Indicates whether subscription logs are being sent.
KnownSendingLogsStatus	Indicates whether logs are being sent.
KnownSendingMetricsStatus	Indicates whether metrics are being sent.
KnownSingleSignOnStates	Various states of the SSO resource
KnownStatus	The state of monitoring.
KnownSubscriptionListOperation	The operation for the patch on the resource.
KnownTagAction	Valid actions for a filtering tag. Exclusion takes priority over inclusion.
KnownUpdateStatus	The current update status of OneAgent.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(DynatraceObservability, 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>(DynatraceObservability, 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: DynatraceObservability, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

DynatraceObservability

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor