@azure/arm-datadog 2.1.1 → 3.0.1-alpha.20220120.1

package/review/arm-datadog.api.md

@@ -0,0 +1,746 @@
+## API Report File for "@azure/arm-datadog"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DatadogAgreementProperties {
+    accepted?: boolean;
+    licenseTextLink?: string;
+    plan?: string;
+    privacyPolicyLink?: string;
+    product?: string;
+    publisher?: string;
+    retrieveDatetime?: Date;
+    signature?: string;
+}
+
+// @public (undocumented)
+export interface DatadogAgreementResource {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: DatadogAgreementProperties;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface DatadogAgreementResourceListResponse {
+    nextLink?: string;
+    value?: DatadogAgreementResource[];
+}
+
+// @public (undocumented)
+export interface DatadogApiKey {
+    created?: string;
+    createdBy?: string;
+    key: string;
+    name?: string;
+}
+
+// @public
+export interface DatadogApiKeyListResponse {
+    nextLink?: string;
+    value?: DatadogApiKey[];
+}
+
+// @public (undocumented)
+export interface DatadogHost {
+    aliases?: string[];
+    apps?: string[];
+    // (undocumented)
+    meta?: DatadogHostMetadata;
+    name?: string;
+}
+
+// @public
+export interface DatadogHostListResponse {
+    nextLink?: string;
+    value?: DatadogHost[];
+}
+
+// @public (undocumented)
+export interface DatadogHostMetadata {
+    agentVersion?: string;
+    // (undocumented)
+    installMethod?: DatadogInstallMethod;
+    // (undocumented)
+    logsAgent?: DatadogLogsAgent;
+}
+
+// @public (undocumented)
+export interface DatadogInstallMethod {
+    installerVersion?: string;
+    tool?: string;
+    toolVersion?: string;
+}
+
+// @public (undocumented)
+export interface DatadogLogsAgent {
+    transport?: string;
+}
+
+// @public (undocumented)
+export interface DatadogMonitorResource {
+    readonly id?: string;
+    // (undocumented)
+    identity?: IdentityProperties;
+    // (undocumented)
+    location: string;
+    readonly name?: string;
+    properties?: MonitorProperties;
+    // (undocumented)
+    sku?: ResourceSku;
+    readonly systemData?: SystemData;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+}
+
+// @public
+export interface DatadogMonitorResourceListResponse {
+    nextLink?: string;
+    value?: DatadogMonitorResource[];
+}
+
+// @public
+export interface DatadogMonitorResourceUpdateParameters {
+    properties?: MonitorUpdateProperties;
+    // (undocumented)
+    sku?: ResourceSku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export interface DatadogOrganizationProperties {
+    apiKey?: string;
+    applicationKey?: string;
+    enterpriseAppId?: string;
+    readonly id?: string;
+    linkingAuthCode?: string;
+    linkingClientId?: string;
+    readonly name?: string;
+    redirectUri?: string;
+}
+
+// @public (undocumented)
+export interface DatadogSetPasswordLink {
+    // (undocumented)
+    setPasswordLink?: string;
+}
+
+// @public (undocumented)
+export interface DatadogSingleSignOnProperties {
+    enterpriseAppId?: string;
+    readonly provisioningState?: ProvisioningState;
+    singleSignOnState?: SingleSignOnStates;
+    readonly singleSignOnUrl?: string;
+}
+
+// @public (undocumented)
+export interface DatadogSingleSignOnResource {
+    readonly id?: string;
+    readonly name?: string;
+    // (undocumented)
+    properties?: DatadogSingleSignOnProperties;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface DatadogSingleSignOnResourceListResponse {
+    nextLink?: string;
+    value?: DatadogSingleSignOnResource[];
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface FilteringTag {
+    action?: TagAction;
+    name?: string;
+    value?: string;
+}
+
+// @public (undocumented)
+export interface IdentityProperties {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: ManagedIdentityTypes;
+}
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownLiftrResourceCategories {
+    // (undocumented)
+    MonitorLogs = "MonitorLogs",
+    // (undocumented)
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownManagedIdentityTypes {
+    // (undocumented)
+    SystemAssigned = "SystemAssigned",
+    // (undocumented)
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownMarketplaceSubscriptionStatus {
+    // (undocumented)
+    Active = "Active",
+    // (undocumented)
+    Provisioning = "Provisioning",
+    // (undocumented)
+    Suspended = "Suspended",
+    // (undocumented)
+    Unsubscribed = "Unsubscribed"
+}
+
+// @public
+export enum KnownMonitoringStatus {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownProvisioningState {
+    // (undocumented)
+    Accepted = "Accepted",
+    // (undocumented)
+    Canceled = "Canceled",
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    Deleted = "Deleted",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    NotSpecified = "NotSpecified",
+    // (undocumented)
+    Succeeded = "Succeeded",
+    // (undocumented)
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownSingleSignOnStates {
+    // (undocumented)
+    Disable = "Disable",
+    // (undocumented)
+    Enable = "Enable",
+    // (undocumented)
+    Existing = "Existing",
+    // (undocumented)
+    Initial = "Initial"
+}
+
+// @public
+export enum KnownTagAction {
+    // (undocumented)
+    Exclude = "Exclude",
+    // (undocumented)
+    Include = "Include"
+}
+
+// @public
+export type LiftrResourceCategories = string;
+
+// @public
+export interface LinkedResource {
+    id?: string;
+}
+
+// @public
+export interface LinkedResourceListResponse {
+    nextLink?: string;
+    value?: LinkedResource[];
+}
+
+// @public
+export interface LogRules {
+    filteringTags?: FilteringTag[];
+    sendAadLogs?: boolean;
+    sendResourceLogs?: boolean;
+    sendSubscriptionLogs?: boolean;
+}
+
+// @public
+export type ManagedIdentityTypes = string;
+
+// @public
+export interface MarketplaceAgreements {
+    createOrUpdate(options?: MarketplaceAgreementsCreateOrUpdateOptionalParams): Promise<MarketplaceAgreementsCreateOrUpdateResponse>;
+    list(options?: MarketplaceAgreementsListOptionalParams): PagedAsyncIterableIterator<DatadogAgreementResource>;
+}
+
+// @public
+export interface MarketplaceAgreementsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    // (undocumented)
+    body?: DatadogAgreementResource;
+}
+
+// @public
+export type MarketplaceAgreementsCreateOrUpdateResponse = DatadogAgreementResource;
+
+// @public
+export interface MarketplaceAgreementsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MarketplaceAgreementsListNextResponse = DatadogAgreementResourceListResponse;
+
+// @public
+export interface MarketplaceAgreementsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MarketplaceAgreementsListResponse = DatadogAgreementResourceListResponse;
+
+// @public
+export type MarketplaceSubscriptionStatus = string;
+
+// @public
+export interface MetricRules {
+    filteringTags?: FilteringTag[];
+}
+
+// @public (undocumented)
+export class MicrosoftDatadogClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MicrosoftDatadogClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    marketplaceAgreements: MarketplaceAgreements;
+    // (undocumented)
+    monitors: Monitors;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    singleSignOnConfigurations: SingleSignOnConfigurations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    tagRules: TagRules;
+}
+
+// @public
+export interface MicrosoftDatadogClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface MonitoredResource {
+    id?: string;
+    reasonForLogsStatus?: string;
+    reasonForMetricsStatus?: string;
+    sendingLogs?: boolean;
+    sendingMetrics?: boolean;
+}
+
+// @public
+export interface MonitoredResourceListResponse {
+    nextLink?: string;
+    value?: MonitoredResource[];
+}
+
+// @public
+export type MonitoringStatus = string;
+
+// @public
+export interface MonitoringTagRules {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: MonitoringTagRulesProperties;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface MonitoringTagRulesListResponse {
+    nextLink?: string;
+    value?: MonitoringTagRules[];
+}
+
+// @public
+export interface MonitoringTagRulesProperties {
+    logRules?: LogRules;
+    metricRules?: MetricRules;
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface MonitorProperties {
+    datadogOrganizationProperties?: DatadogOrganizationProperties;
+    readonly liftrResourceCategory?: LiftrResourceCategories;
+    readonly liftrResourcePreference?: number;
+    readonly marketplaceSubscriptionStatus?: MarketplaceSubscriptionStatus;
+    monitoringStatus?: MonitoringStatus;
+    readonly provisioningState?: ProvisioningState;
+    userInfo?: UserInfo;
+}
+
+// @public
+export interface Monitors {
+    beginCreate(resourceGroupName: string, monitorName: string, options?: MonitorsCreateOptionalParams): Promise<PollerLike<PollOperationState<MonitorsCreateResponse>, MonitorsCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, monitorName: string, options?: MonitorsCreateOptionalParams): Promise<MonitorsCreateResponse>;
+    beginDelete(resourceGroupName: string, monitorName: string, options?: MonitorsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, monitorName: string, options?: MonitorsDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, monitorName: string, options?: MonitorsUpdateOptionalParams): Promise<PollerLike<PollOperationState<MonitorsUpdateResponse>, MonitorsUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, monitorName: string, options?: MonitorsUpdateOptionalParams): Promise<MonitorsUpdateResponse>;
+    get(resourceGroupName: string, monitorName: string, options?: MonitorsGetOptionalParams): Promise<MonitorsGetResponse>;
+    getDefaultKey(resourceGroupName: string, monitorName: string, options?: MonitorsGetDefaultKeyOptionalParams): Promise<MonitorsGetDefaultKeyResponse>;
+    list(options?: MonitorsListOptionalParams): PagedAsyncIterableIterator<DatadogMonitorResource>;
+    listApiKeys(resourceGroupName: string, monitorName: string, options?: MonitorsListApiKeysOptionalParams): PagedAsyncIterableIterator<DatadogApiKey>;
+    listByResourceGroup(resourceGroupName: string, options?: MonitorsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DatadogMonitorResource>;
+    listHosts(resourceGroupName: string, monitorName: string, options?: MonitorsListHostsOptionalParams): PagedAsyncIterableIterator<DatadogHost>;
+    listLinkedResources(resourceGroupName: string, monitorName: string, options?: MonitorsListLinkedResourcesOptionalParams): PagedAsyncIterableIterator<LinkedResource>;
+    listMonitoredResources(resourceGroupName: string, monitorName: string, options?: MonitorsListMonitoredResourcesOptionalParams): PagedAsyncIterableIterator<MonitoredResource>;
+    refreshSetPasswordLink(resourceGroupName: string, monitorName: string, options?: MonitorsRefreshSetPasswordLinkOptionalParams): Promise<MonitorsRefreshSetPasswordLinkResponse>;
+    setDefaultKey(resourceGroupName: string, monitorName: string, options?: MonitorsSetDefaultKeyOptionalParams): Promise<void>;
+}
+
+// @public
+export interface MonitorsCreateOptionalParams extends coreClient.OperationOptions {
+    // (undocumented)
+    body?: DatadogMonitorResource;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type MonitorsCreateResponse = DatadogMonitorResource;
+
+// @public
+export interface MonitorsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MonitorsGetDefaultKeyOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsGetDefaultKeyResponse = DatadogApiKey;
+
+// @public
+export interface MonitorsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsGetResponse = DatadogMonitorResource;
+
+// @public
+export interface MonitorsListApiKeysNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListApiKeysNextResponse = DatadogApiKeyListResponse;
+
+// @public
+export interface MonitorsListApiKeysOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListApiKeysResponse = DatadogApiKeyListResponse;
+
+// @public
+export interface MonitorsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListByResourceGroupNextResponse = DatadogMonitorResourceListResponse;
+
+// @public
+export interface MonitorsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListByResourceGroupResponse = DatadogMonitorResourceListResponse;
+
+// @public
+export interface MonitorsListHostsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListHostsNextResponse = DatadogHostListResponse;
+
+// @public
+export interface MonitorsListHostsOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListHostsResponse = DatadogHostListResponse;
+
+// @public
+export interface MonitorsListLinkedResourcesNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListLinkedResourcesNextResponse = LinkedResourceListResponse;
+
+// @public
+export interface MonitorsListLinkedResourcesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListLinkedResourcesResponse = LinkedResourceListResponse;
+
+// @public
+export interface MonitorsListMonitoredResourcesNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListMonitoredResourcesNextResponse = MonitoredResourceListResponse;
+
+// @public
+export interface MonitorsListMonitoredResourcesOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListMonitoredResourcesResponse = MonitoredResourceListResponse;
+
+// @public
+export interface MonitorsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListNextResponse = DatadogMonitorResourceListResponse;
+
+// @public
+export interface MonitorsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsListResponse = DatadogMonitorResourceListResponse;
+
+// @public
+export interface MonitorsRefreshSetPasswordLinkOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MonitorsRefreshSetPasswordLinkResponse = DatadogSetPasswordLink;
+
+// @public
+export interface MonitorsSetDefaultKeyOptionalParams extends coreClient.OperationOptions {
+    // (undocumented)
+    body?: DatadogApiKey;
+}
+
+// @public
+export interface MonitorsUpdateOptionalParams extends coreClient.OperationOptions {
+    body?: DatadogMonitorResourceUpdateParameters;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type MonitorsUpdateResponse = DatadogMonitorResource;
+
+// @public
+export interface MonitorUpdateProperties {
+    monitoringStatus?: MonitoringStatus;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationListResult {
+    nextLink?: string;
+    value?: OperationResult[];
+}
+
+// @public
+export interface OperationResult {
+    display?: OperationDisplay;
+    isDataAction?: boolean;
+    name?: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationResult>;
+}
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListNextResponse = OperationListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationListResult;
+
+// @public
+export type ProvisioningState = string;
+
+// @public (undocumented)
+export interface ResourceSku {
+    name: string;
+}
+
+// @public
+export interface SingleSignOnConfigurations {
+    beginCreateOrUpdate(resourceGroupName: string, monitorName: string, configurationName: string, options?: SingleSignOnConfigurationsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SingleSignOnConfigurationsCreateOrUpdateResponse>, SingleSignOnConfigurationsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, monitorName: string, configurationName: string, options?: SingleSignOnConfigurationsCreateOrUpdateOptionalParams): Promise<SingleSignOnConfigurationsCreateOrUpdateResponse>;
+    get(resourceGroupName: string, monitorName: string, configurationName: string, options?: SingleSignOnConfigurationsGetOptionalParams): Promise<SingleSignOnConfigurationsGetResponse>;
+    list(resourceGroupName: string, monitorName: string, options?: SingleSignOnConfigurationsListOptionalParams): PagedAsyncIterableIterator<DatadogSingleSignOnResource>;
+}
+
+// @public
+export interface SingleSignOnConfigurationsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    // (undocumented)
+    body?: DatadogSingleSignOnResource;
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type SingleSignOnConfigurationsCreateOrUpdateResponse = DatadogSingleSignOnResource;
+
+// @public
+export interface SingleSignOnConfigurationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SingleSignOnConfigurationsGetResponse = DatadogSingleSignOnResource;
+
+// @public
+export interface SingleSignOnConfigurationsListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SingleSignOnConfigurationsListNextResponse = DatadogSingleSignOnResourceListResponse;
+
+// @public
+export interface SingleSignOnConfigurationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SingleSignOnConfigurationsListResponse = DatadogSingleSignOnResourceListResponse;
+
+// @public
+export type SingleSignOnStates = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TagAction = string;
+
+// @public
+export interface TagRules {
+    createOrUpdate(resourceGroupName: string, monitorName: string, ruleSetName: string, options?: TagRulesCreateOrUpdateOptionalParams): Promise<TagRulesCreateOrUpdateResponse>;
+    get(resourceGroupName: string, monitorName: string, ruleSetName: string, options?: TagRulesGetOptionalParams): Promise<TagRulesGetResponse>;
+    list(resourceGroupName: string, monitorName: string, options?: TagRulesListOptionalParams): PagedAsyncIterableIterator<MonitoringTagRules>;
+}
+
+// @public
+export interface TagRulesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    body?: MonitoringTagRules;
+}
+
+// @public
+export type TagRulesCreateOrUpdateResponse = MonitoringTagRules;
+
+// @public
+export interface TagRulesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TagRulesGetResponse = MonitoringTagRules;
+
+// @public
+export interface TagRulesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TagRulesListNextResponse = MonitoringTagRulesListResponse;
+
+// @public
+export interface TagRulesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type TagRulesListResponse = MonitoringTagRulesListResponse;
+
+// @public
+export interface UserInfo {
+    emailAddress?: string;
+    name?: string;
+    phoneNumber?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```