@azure/arm-newrelicobservability package

Interfaces

AccountInfo

Account Info of the NewRelic account

AccountProperties

List of all the New relic accounts for the given user

AccountResource

The details of a account resource.

AccountsListOptionalParams

Optional parameters.

AccountsOperations

Interface representing a Accounts operations.

ActivateSaaSParameterRequest

SaaS guid & PublishedId for Activate and Validate SaaS Resource

AppServiceInfo

Details of VM Resource having NewRelic OneAgent installed

AppServicesGetRequest

Request of a app services get Operation.

BillingInfoGetOptionalParams

Optional parameters.

BillingInfoOperations

Interface representing a BillingInfo operations.

BillingInfoResponse

Marketplace Subscription and Organization details to which resource gets billed into.

ConnectedPartnerResourceProperties

Connected Partner Resource Properties

ConnectedPartnerResourcesListFormat

Connected Partner Resources List Format

ConnectedPartnerResourcesListOptionalParams

Optional parameters.

ConnectedPartnerResourcesOperations

Interface representing a ConnectedPartnerResources operations.

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.

HostsGetRequest

Request of a Hosts get Operation.

LatestLinkedSaaSResponse

Response of get latest linked SaaS resource operation

LinkedResource

The definition of a linked resource.

LogRules

Set of rules for sending logs for the Monitor resource.

ManagedServiceIdentity

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

MarketplaceSaaSInfo

Marketplace SAAS Info of the resource.

MetricRules

Set of rules for sending metrics for the Monitor resource.

MetricsRequest

Request of get metrics Operation.

MetricsStatusRequest

Request of get metrics status Operation.

MetricsStatusResponse

Response of get metrics status Operation.

MonitorProperties

Properties specific to the NewRelic Monitor resource

MonitoredResource

Details of resource being monitored by NewRelic monitor resource

MonitoredSubscription

The list of subscriptions and it's monitoring status by current NewRelic monitor.

MonitoredSubscriptionProperties

The request to update subscriptions needed to be monitored by the NewRelic monitor resource.

MonitoredSubscriptionsCreateOrUpdateOptionalParams

Optional parameters.

MonitoredSubscriptionsDeleteOptionalParams

Optional parameters.

MonitoredSubscriptionsGetOptionalParams

Optional parameters.

MonitoredSubscriptionsListOptionalParams

Optional parameters.

MonitoredSubscriptionsOperations

Interface representing a MonitoredSubscriptions operations.

MonitoredSubscriptionsUpdateOptionalParams

Optional parameters.

MonitoringTagRulesProperties

The resource-specific properties for this resource.

MonitorsCreateOrUpdateOptionalParams

Optional parameters.

MonitorsDeleteOptionalParams

Optional parameters.

MonitorsGetMetricRulesOptionalParams

Optional parameters.

MonitorsGetMetricStatusOptionalParams

Optional parameters.

MonitorsGetOptionalParams

Optional parameters.

MonitorsLatestLinkedSaaSOptionalParams

Optional parameters.

MonitorsLinkSaaSOptionalParams

Optional parameters.

MonitorsListAppServicesOptionalParams

Optional parameters.

MonitorsListByResourceGroupOptionalParams

Optional parameters.

MonitorsListBySubscriptionOptionalParams

Optional parameters.

MonitorsListHostsOptionalParams

Optional parameters.

MonitorsListLinkedResourcesOptionalParams

Optional parameters.

MonitorsListMonitoredResourcesOptionalParams

Optional parameters.

MonitorsOperations

Interface representing a Monitors operations.

MonitorsRefreshIngestionKeyOptionalParams

Optional parameters.

MonitorsResubscribeOptionalParams

Optional parameters.

MonitorsSwitchBillingOptionalParams

Optional parameters.

MonitorsUpdateOptionalParams

Optional parameters.

MonitorsVmHostPayloadOptionalParams

Optional parameters.

NewRelicAccountProperties

Properties of the NewRelic account

NewRelicMonitorResource

A Monitor Resource by NewRelic

NewRelicMonitorResourceUpdate

The type used for update operations of the NewRelicMonitorResource.

NewRelicMonitorResourceUpdateProperties

The updatable properties of the NewRelicMonitorResource.

NewRelicObservabilityOptionalParams

Optional parameters for the client.

NewRelicSingleSignOnProperties

Single sign on Info of the NewRelic account

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.

OrganizationInfo

Organization Info of the NewRelic account

OrganizationProperties

Details of Organizations

OrganizationResource

The details of a Organization resource.

OrganizationsListOptionalParams

Optional parameters.

OrganizationsOperations

Interface representing a Organizations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

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

PartnerBillingEntity

Partner Billing details associated with the resource.

PlanData

Plan data of NewRelic Monitor resource

PlanDataProperties

Plan details

PlanDataResource

The details of a PlanData resource.

PlansListOptionalParams

Optional parameters.

PlansOperations

Interface representing a Plans operations.

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
ResubscribeProperties

Resubscribe Properties

SaaSActivateResourceOptionalParams

Optional parameters.

SaaSData

SaaS details

SaaSOperations

Interface representing a SaaS operations.

SaaSResourceDetailsResponse

Marketplace SaaS resource details.

SimplePollerLike

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

SubscriptionList

The request to update subscriptions needed to be monitored by the NewRelic monitor resource.

SwitchBillingRequest

Request of a switch billing Operation.

SystemData

Metadata pertaining to creation and last modification of the resource.

TagRule

A tag rule belonging to NewRelic account

TagRuleUpdate

The type used for update operations of the TagRule.

TagRuleUpdateProperties

The updatable properties of the TagRule.

TagRulesCreateOrUpdateOptionalParams

Optional parameters.

TagRulesDeleteOptionalParams

Optional parameters.

TagRulesGetOptionalParams

Optional parameters.

TagRulesListByNewRelicMonitorResourceOptionalParams

Optional parameters.

TagRulesOperations

Interface representing a TagRules operations.

TagRulesUpdateOptionalParams

Optional parameters.

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

UserInfo

User Info of NewRelic Monitor resource

VMExtensionPayload

Response of payload to be passed while installing VM agent.

VMInfo

Details of VM Resource having NewRelic OneAgent installed

Type Aliases

AccountCreationSource

Source of Account creation
KnownAccountCreationSource can be used interchangeably with AccountCreationSource, this enum contains the known values that the service supports.

Known values supported by the service

LIFTR: Account is created from LIFTR
NEWRELIC: Account is created from NEWRELIC

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.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

BillingSource

Billing source
KnownBillingSource can be used interchangeably with BillingSource, this enum contains the known values that the service supports.

Known values supported by the service

AZURE: Billing source is Azure
NEWRELIC

ConfigurationName

Type of ConfigurationName

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

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.

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: monitoring is enabled
Suspended: monitoring is disabled

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: monitoring is enabled
Disabled: monitoring is disabled

OrgCreationSource

Source of Org creation
KnownOrgCreationSource can be used interchangeably with OrgCreationSource, this enum contains the known values that the service supports.

Known values supported by the service

LIFTR: Org is created from LIFTR
NEWRELIC: Org is created from NEWRELIC

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.

PatchOperation

The operation for the patch on the resource.
KnownPatchOperation can be used interchangeably with PatchOperation, this enum contains the known values that the service supports.

Known values supported by the service

AddBegin
AddComplete
DeleteBegin
DeleteComplete
Active

ProvisioningState

Provisioning State of the Monitor 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: Monitor resource creation request accepted
Creating: Monitor resource creation started
Updating: Monitor resource is being updated
Deleting: Monitor resource deletion started
Succeeded: Monitor resource creation successful
Failed: Monitor resource creation failed
Canceled: Monitor resource creation canceled
Deleted: Monitor resource is deleted
NotSpecified: Monitor resource state is unknown

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

SendMetricsStatus

Indicates whether metrics are being sent.
KnownSendMetricsStatus can be used interchangeably with SendMetricsStatus, 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

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

UsageType

Different usage type like PAYG/COMMITTED
KnownUsageType can be used interchangeably with UsageType, this enum contains the known values that the service supports.

Known values supported by the service

PAYG: Usage type is PAYG
COMMITTED: Usage type is COMMITTED

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownAccountCreationSource

Source of Account creation

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownBillingSource

Billing source

KnownConfigurationName

Known values of ConfigurationName that the service accepts.

KnownCreatedByType

The kind of entity that created the resource.

KnownLiftrResourceCategories

Liftr Resource category.

KnownManagedServiceIdentityType

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

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.

KnownOrgCreationSource

Source of Org creation

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownPatchOperation

The operation for the patch on the resource.

KnownProvisioningState

Provisioning State of the Monitor resource

KnownSendAadLogsStatus

Indicates whether AAD logs are being sent.

KnownSendActivityLogsStatus

Indicates whether activity logs are being sent.

KnownSendMetricsStatus

Indicates whether metrics 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.

KnownTagAction

Valid actions for a filtering tag. Exclusion takes priority over inclusion.

KnownUsageType

Different usage type like PAYG/COMMITTED

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

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

Parameters

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