MetricsAdvisorAdministrationClient class

Creates an instance of MetricsAdvisorAdministrationClient.

Example usage:

import { MetricsAdvisorAdministrationClient, MetricsAdvisorKeyCredential } from "@azure/ai-metrics-advisor";

const client = new MetricsAdvisorAdministrationClient(
   "<service endpoint>",
   new MetricsAdvisorKeyCredential("<subscription key>", "<api key>")
);

new MetricsAdvisorAdministrationClient(endpointUrl: string, credential: TokenCredential | MetricsAdvisorKeyCredential, options?: MetricsAdvisorAdministrationClientOptions)

Parameters

Url to service endpoint

endpointUrl: string

Property Value

Creates anomaly alerting configuration for a given metric

function createAlertConfig(config: Omit<AnomalyAlertConfiguration, "id">, options?: OperationOptions): Promise<AnomalyAlertConfiguration>

Parameters

Returns

Response with Alert object

Adds a new data feed for a specific data source and provided settings

function createDataFeed(feed: DataFeedDescriptor, operationOptions?: CreateDataFeedOptions): Promise<MetricsAdvisorDataFeed>

Parameters

Returns

Response with Datafeed object

Creates data source credential for the given id

function createDataSourceCredential(dataSourceCredential: DataSourceCredentialEntityUnion, options?: OperationOptions): Promise<DataSourceCredentialEntityUnion>

Parameters

Returns

Creates an anomaly detection configuration for a given metric

function createDetectionConfig(config: Omit<AnomalyDetectionConfiguration, "id">, options?: OperationOptions): Promise<AnomalyDetectionConfiguration>

Parameters

Returns

Response with Detection Config object

Adds a new hook

function createHook(hookInfo: EmailNotificationHook | WebNotificationHook, options?: OperationOptions): Promise<NotificationHookUnion>

Parameters

Returns

Response with Hook object

Deletes metric anomaly alert configuration for the given configuration id

function deleteAlertConfig(id: string, options?: OperationOptions): Promise<RestResponse>

Parameters

Returns

Deletes a data feed for the given data feed id

function deleteDataFeed(id: string, options?: OperationOptions): Promise<RestResponse>

Parameters

Returns

Deletes data source credential for the given id

function deleteDataSourceCredential(id: string, options?: OperationOptions): Promise<RestResponse>

Parameters

Returns

Deletes a metric anomaly detection configuration for the given configuration id

function deleteDetectionConfig(id: string, options?: OperationOptions): Promise<RestResponse>

Parameters

Returns

Deletes hook for the given hook id

function deleteHook(id: string, options?: OperationOptions): Promise<RestResponse>

Parameters

Returns

Retrieves metric anomaly alert configuration for the given configuration id

function getAlertConfig(id: string, options?: OperationOptions): Promise<AnomalyAlertConfiguration>

Parameters

Returns

Retrieves data feed for the given data feed id

function getDataFeed(id: string, options?: OperationOptions): Promise<MetricsAdvisorDataFeed>

Parameters

Returns

Retrieves data feed ingestion progress for the given data feed id

function getDataFeedIngestionProgress(dataFeedId: string, options?: {}): Promise<GetIngestionProgressResponse>

Parameters

Returns

Retrieves data source credential for the given id

function getDataSourceCredential(id: string, options?: OperationOptions): Promise<DataSourceCredentialEntityUnion>

Parameters

Returns

Retrieves metric anomaly detection configuration for the given configuration id

function getDetectionConfig(id: string, options?: OperationOptions): Promise<AnomalyDetectionConfiguration>

Parameters

Returns

Retrieves hook for the given hook id

function getHook(id: string, options?: OperationOptions): Promise<NotificationHookUnion>

Parameters

Returns

Returns an async iterable iterator to list anamoly alert configurations associated with the given detection configuration.

.byPage() returns an async iterable iterator to list the alert configurations in pages.

Example using for await syntax:

const client = new MetricsAdvisorAdministrationClient(endpoint,
  new MetricsAdvisorKeyCredential(subscriptionKey, apiKey));
const alertConfigurations = client.listAlertConfigs(detectionConfigurationId);
let i = 1;
for await (const alertConfiguration of alertConfigurations){
 console.log(`alertConfiguration ${i++}:`);
 console.log(alertConfiguration);
}

Example using iter.next():

let iter = client.listAlertConfigs(detectionConfigurationId);
let result = await iter.next();
while (!result.done) {
  console.log(` alert - ${result.value.id}, ${result.value.name}`);
  result = await iter.next();
}

Example using byPage():

const pages = client.listAlertConfigs(detectionConfigurationId)
  .byPage();
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value.alertConfigurations) {
   console.log(`-- page ${i++}`);
   for (const alert of page.value) {
     console.log(`${alert}`);
   }
 }
 page = await pages.next();
}

function listAlertConfigs(detectionConfigId: string, options?: OperationOptions): PagedAsyncIterableIterator<AnomalyAlertConfiguration, AlertConfigurationsPageResponse, undefined>

Parameters

Returns

Returns an async iterable iterator to list data feed ingestion status based on options

.byPage() returns an async iterable iterator to list the data feed ingestion status in pages.

Example using for await syntax:

const client = new MetricsAdvisorAdministrationClient(endpoint,
  new MetricsAdvisorKeyCredential(subscriptionKey, apiKey));
const ingestionStatusList = client.listDataFeedIngestionStatus(dataFeedId);
let i = 1;
for await (const ingestionStatus of ingestionStatusList){
 console.log(`ingestionStatus ${i++}:`);
 console.log(ingestionStatus);
}

Example using iter.next():

let iter = client.listDataFeedIngestionStatus(dataFeedId);
let result = await iter.next();
while (!result.done) {
  console.log(` anomaly - ${result.value.timestamp}, ${result.value.status}, ${result.value.mesage}`);
  result = await iter.next();
}

Example using byPage():

const pages = client.listDataFeedIngestionStatus(dataFeedId).byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const status of page.value) {
     console.log("ingestion status-");
     console.dir(status);
   }
 }
 page = await pages.next();
}

function listDataFeedIngestionStatus(dataFeedId: string, startTime: string | Date, endTime: string | Date, options?: ListDataFeedIngestionStatusOptions): PagedAsyncIterableIterator<IngestionStatus, IngestionStatusPageResponse, PageSettings>

Parameters

Returns

Returns an async iterable iterator to list data feeds based on options

.byPage() returns an async iterable iterator to list the blobs in pages.

Example using for await syntax:

const client = new MetricsAdvisorAdministrationClient(endpoint,
  new MetricsAdvisorKeyCredential(subscriptionKey, apiKey));
const dataFeedList = client.listDataFeeds({
filter: { // filter
 dataFeedName: "js-blob-datafeed"
 }
});
let i = 1;
for await (const datafeed of dataFeedList){
 console.log(`datafeed ${i++}:`);
 console.log(datafeed);
}

Example using iter.next():

let iter = client.listDataFeeds();
let dataFeedItem = await iter.next();
while (!dataFeedItem.done) {
  console.log(`id :${dataFeedItem.value.id}, name: ${dataFeedItem.value.name}`);
  dataFeedItem = await iter.next();
}

Example using byPage():

const pages = client.listDataFeeds().byPage({ maxPageSize: 10 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const feed of page.value) {
     console.log(`  ${feed.id} - ${feed.name}`);
   }
 }
 page = await pages.next();
}

function listDataFeeds(options?: ListDataFeedsOptions): PagedAsyncIterableIterator<MetricsAdvisorDataFeed, DataFeedsPageResponse, PageSettings>

Parameters

Returns

Returns an async iterable iterator to list data source credentials based on options

.byPage() returns an async iterable iterator to list the credentials in pages.

Example using for await syntax:

const client = new MetricsAdvisorAdministrationClient(endpoint,
  new MetricsAdvisorKeyCredential(subscriptionKey, apiKey));
const dataSourceCredentialList = client.listDataSourceCredential();
let i = 1;
for await (const dataSourceCredential of dataSourceCredentialList){
 console.log(`dataSourceCredential ${i++}:`);
 console.log(dataSourceCredential);
}

Example using iter.next():

let iter = client.listDataSourceCredential();
let result = await iter.next();
while (!result.done) {
  console.dir(result);
  result = await iter.next();
}

Example using byPage():

const pages = client.listDataSourceCredential().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const credential of page.value) {
     console.log("dataSource credential-");
     console.dir(credential);
   }
 }
 page = await pages.next();
}

function listDataSourceCredential(options?: ListDataSourceCredentialsOptions): PagedAsyncIterableIterator<DataSourceCredentialEntityUnion, CredentialsPageResponse, PageSettings>

Parameters

Returns

Returns an async iterable iterator to list anomaly detection configurations based on options

.byPage() returns an async iterable iterator to list the anomaly detection configurations in pages.

Example using for await syntax:

const client = new MetricsAdvisorAdministrationClient(endpoint,
  new MetricsAdvisorKeyCredential(subscriptionKey, apiKey));
const anomalyDetectionList = client.listDetectionConfigs(metricId);
let i = 1;
for await (const anomaly of anomalyDetectionList){
 console.log(`anomaly ${i++}:`);
 console.log(anomaly);
}

Example using iter.next():

let iter = client.listDetectionConfigs(metricId);
let result = await iter.next();
while (!result.done) {
  console.log(` anomaly - ${result.value.id}, ${result.value.name}`);
  result = await iter.next();
}

Example using byPage():

const pages = client.listDetectionConfigs(metricId)
  .byPage();
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const detectionConfiguration of page.value) {
     console.log("detection configuration-");
     console.dir(detectionConfiguration);
   }
 }
 page = await pages.next();
}

function listDetectionConfigs(metricId: string, options?: OperationOptions): PagedAsyncIterableIterator<AnomalyDetectionConfiguration, DetectionConfigurationsPageResponse, undefined>

Parameters

Returns

Returns an async iterable iterator to list hooks based on options

.byPage() returns an async iterable iterator to list the hooks in pages.

Example using for await syntax:

const client = new MetricsAdvisorAdministrationClient(endpoint,
  new MetricsAdvisorKeyCredential(subscriptionKey, apiKey));
const hookList = client.listHooks();
let i = 1;
for await (const hook of hookList){
 console.log(`hook ${i++}:`);
 console.log(hook);
}

Example using iter.next():

let iter = client.listHooks();
let result = await iter.next();
while (!result.done) {
  console.log(` hook - ${result.value.id}`);
  result = await iter.next();
}

Example using byPage():

const pages = client.listHooks().byPage({ maxPageSize: 2 });
let page = await pages.next();
let i = 1;
while (!page.done) {
 if (page.value) {
   console.log(`-- page ${i++}`);
   for (const hook of page.value) {
     console.log("hook-");
     console.dir(hook);
   }
 }
 page = await pages.next();
}

function listHooks(options?: ListHooksOptions): PagedAsyncIterableIterator<NotificationHookUnion, HooksPageResponse, PageSettings>

Parameters

Returns

Refreshes or resets data feed ingestion progress for the given data feed id

function refreshDataFeedIngestion(dataFeedId: string, startTime: string | Date, endTime: string | Date, options?: OperationOptions): Promise<RestResponse>

Parameters

Returns

Updates an anomaly alert configuration for the given configuration id

function updateAlertConfig(id: string, patch: Partial<Omit<AnomalyAlertConfiguration, "id">>, options?: OperationOptions): Promise<AnomalyAlertConfiguration>

Parameters

Returns

Updates a data feed given its id

function updateDataFeed(dataFeedId: string, patch: DataFeedPatch, options?: OperationOptions): Promise<MetricsAdvisorDataFeed>

Parameters

Returns

Updates data source credential for the given id

function updateDataSourceCredential(id: string, patch: DataSourceCredentialPatch, options?: OperationOptions): Promise<DataSourceCredentialEntityUnion>

Parameters

Returns

Updates a metric anomaly detection configuration for the given configuration id

function updateDetectionConfig(id: string, patch: AnomalyDetectionConfigurationPatch, options?: OperationOptions): Promise<AnomalyDetectionConfiguration>

Parameters

Returns

Updates hook for the given hook id

function updateHook(id: string, patch: EmailNotificationHookPatch | WebNotificationHookPatch, options?: OperationOptions): Promise<NotificationHookUnion>

Parameters

Returns