@azure/arm-datadog package

Interfaces

ActivateSaaSParameterRequest

SaaS resource details for Activate and Validate SaaS Resource

AgentRules

Set of rules for managing agents for the Monitor resource.

BillingInfoGetOptionalParams

Optional parameters.

BillingInfoOperations

Interface representing a BillingInfo operations.

BillingInfoResponse

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

CreateResourceSupportedProperties

Datadog resource can be created or not properties.

CreateResourceSupportedResponse

Datadog resource can be created or not.

CreationSupportedGetOptionalParams

Optional parameters.

CreationSupportedListOptionalParams

Optional parameters.

CreationSupportedOperations

Interface representing a CreationSupported operations.

DatadogAgreementProperties

Terms properties.

DatadogAgreementResource

model interface DatadogAgreementResource

DatadogApiKey

model interface DatadogApiKey

DatadogApplicationKey

Represents a Datadog Application key and its associated properties.

DatadogHost

model interface DatadogHost

DatadogHostMetadata

model interface DatadogHostMetadata

DatadogInstallMethod

model interface DatadogInstallMethod

DatadogLogsAgent

model interface DatadogLogsAgent

DatadogMonitorResource

Concrete tracked resource types can be created by aliasing this type using a specific property type.

DatadogMonitorResourceUpdateParameters

The parameters for a PATCH request to a monitor resource.

DatadogMonitorResourcesLatestLinkedSaaSOptionalParams

Optional parameters.

DatadogMonitorResourcesLinkSaaSOptionalParams

Optional parameters.

DatadogMonitorResourcesOperations

Interface representing a DatadogMonitorResources operations.

DatadogOrganizationProperties

Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.

DatadogSetPasswordLink

model interface DatadogSetPasswordLink

DatadogSingleSignOnProperties

model interface DatadogSingleSignOnProperties

DatadogSingleSignOnResource

Concrete proxy resource types can be created by aliasing this type using a specific property type.

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

model interface IdentityProperties

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.

MarketplaceAgreementsCreateOrUpdateOptionalParams

Optional parameters.

MarketplaceAgreementsListOptionalParams

Optional parameters.

MarketplaceAgreementsOperations

Interface representing a MarketplaceAgreements operations.

MarketplaceOfferDetails

Details about the marketplace offer associated with the monitor resource.

MarketplaceSaaSInfo

Marketplace SAAS Info of the resource.

MetricRules

Set of rules for sending metrics for the Monitor resource.

MicrosoftDatadogClientOptionalParams

Optional parameters for the client.

MonitorProperties

Properties specific to the monitor resource.

MonitorUpdateProperties

The set of properties that can be update in a PATCH request to a monitor resource.

MonitoredResource

The properties of a resource currently being monitored by the Datadog monitor resource.

MonitoredSubscription

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

MonitoredSubscriptionProperties

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

MonitoredSubscriptionsCreateorUpdateOptionalParams

Optional parameters.

MonitoredSubscriptionsDeleteOptionalParams

Optional parameters.

MonitoredSubscriptionsGetOptionalParams

Optional parameters.

MonitoredSubscriptionsListOptionalParams

Optional parameters.

MonitoredSubscriptionsOperations

Interface representing a MonitoredSubscriptions operations.

MonitoredSubscriptionsUpdateOptionalParams

Optional parameters.

MonitoringTagRules

Capture logs and metrics of Azure resources based on ARM tags.

MonitoringTagRulesProperties

Definition of the properties for a TagRules resource.

MonitorsCreateOptionalParams

Optional parameters.

MonitorsDeleteOptionalParams

Optional parameters.

MonitorsGetDefaultApplicationKeyOptionalParams

Optional parameters.

MonitorsGetDefaultKeyOptionalParams

Optional parameters.

MonitorsGetOptionalParams

Optional parameters.

MonitorsListApiKeysOptionalParams

Optional parameters.

MonitorsListByResourceGroupOptionalParams

Optional parameters.

MonitorsListHostsOptionalParams

Optional parameters.

MonitorsListLinkedResourcesOptionalParams

Optional parameters.

MonitorsListMonitoredResourcesOptionalParams

Optional parameters.

MonitorsListOptionalParams

Optional parameters.

MonitorsManageSreAgentConnectorsOptionalParams

Optional parameters.

MonitorsOperations

Interface representing a Monitors operations.

MonitorsRefreshSetPasswordLinkOptionalParams

Optional parameters.

MonitorsSetDefaultKeyOptionalParams

Optional parameters.

MonitorsUpdateOptionalParams

Optional parameters.

OperationDisplay

The object that represents the operation.

OperationResult

A Microsoft.Datadog REST API operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

OrganizationsOperations

Interface representing a Organizations operations.

OrganizationsResubscribeOptionalParams

Optional parameters.

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.

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

ResourceSku

model interface ResourceSku

RestorePollerOptions
ResubscribeProperties

Resubscribe Properties

SaaSData

SaaS details

SaaSOperationGroupActivateResourceOptionalParams

Optional parameters.

SaaSOperationGroupOperations

Interface representing a SaaSOperationGroup operations.

SaaSResourceDetailsResponse

Marketplace SaaS resource details.

SimplePollerLike

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

SingleSignOnConfigurationsCreateOrUpdateOptionalParams

Optional parameters.

SingleSignOnConfigurationsGetOptionalParams

Optional parameters.

SingleSignOnConfigurationsListOptionalParams

Optional parameters.

SingleSignOnConfigurationsOperations

Interface representing a SingleSignOnConfigurations operations.

SreAgentConfiguration

SRE Agent configuration to connect to MCP server of Datadog for a given organization.

SreAgentConfigurationListResponse

Response of a list operation.

SreAgentConnectorRequest

Request for adding/removing Datadog MCP connectors on SRE Agent resource.

SubscriptionList

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

SystemData

Metadata pertaining to creation and last modification of the resource.

TagRulesCreateOrUpdateOptionalParams

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'

UserInfo

Includes name, email and optionally, phone number. User Information can't be null.

Type Aliases

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ConnectorAction

Add or Remove connectors for SRE agents.
KnownConnectorAction can be used interchangeably with ConnectorAction, this enum contains the known values that the service supports.

Known values supported by the service

Add: Add connector actions
Remove: Remove connector action

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

Type of LiftrResourceCategories

ManagedIdentityTypes

Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.
KnownManagedIdentityTypes can be used interchangeably with ManagedIdentityTypes, this enum contains the known values that the service supports.

Known values supported by the service

SystemAssigned
UserAssigned

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

Provisioning
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

Operation

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

Known values supported by the service

AddBegin
AddComplete
DeleteBegin
DeleteComplete
Active

ProvisioningState

Type of ProvisioningState

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

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownConnectorAction

Add or Remove connectors for SRE agents.

KnownCreatedByType

The kind of entity that created the resource.

KnownLiftrResourceCategories

Known values of LiftrResourceCategories that the service accepts.

KnownManagedIdentityTypes

Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.

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.

KnownOperation

The operation for the patch on the resource.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownSingleSignOnStates

Various states of the SSO resource

KnownStatus

The state of monitoring.

KnownTagAction

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

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(MicrosoftDatadogClient, 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>(MicrosoftDatadogClient, 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: MicrosoftDatadogClient, 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