MetricsAdvisorAdministrationClient class

创建 MetricsAdvisorAdministrationClient 的实例。

示例用法：

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)

参数

指向服务终结点的 URL

endpointUrl: string

属性值

为给定指标创建异常警报配置

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

参数

返回

使用警报对象的响应

为特定数据源添加新的数据源和提供的设置

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

参数

返回

使用 Datafeed 对象的响应

为给定 ID 创建数据源凭据

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

参数

返回

为给定指标创建异常情况检测配置

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

参数

返回

使用检测配置对象的响应

添加新挂钩

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

参数

返回

使用 Hook 对象的响应

删除给定配置 ID 的指标异常警报配置

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

参数

返回

删除给定数据馈送 ID 的数据馈送

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

参数

返回

删除给定 ID 的数据源凭据

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

参数

返回

删除给定配置 ID 的指标异常情况检测配置

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

参数

返回

删除给定挂钩 ID 的挂钩

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

参数

返回

检索给定配置 ID 的指标异常警报配置

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

参数

返回

检索给定数据馈送 ID 的数据馈送

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

参数

返回

检索给定数据馈送 ID 的数据馈送引入进度

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

参数

返回

检索给定 ID 的数据源凭据

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

参数

返回

检索给定配置 ID 的指标异常情况检测配置

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

参数

返回

检索给定挂钩 ID 的挂钩

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

参数

返回

返回一个异步可迭代迭代迭代器，以列出与给定检测配置关联的异步警报配置。

.byPage() 返回异步可迭代迭代器以列出页面中的警报配置。

使用 for await 语法的示例：

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);
}

使用 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();
}

使用 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>

参数

返回

返回异步可迭代迭代器，以基于选项列出数据馈送引入状态

.byPage() 返回异步可迭代迭代器，以在页面中列出数据馈送引入状态。

使用 for await 语法的示例：

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);
}

使用 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();
}

使用 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>

参数

返回

返回异步可迭代迭代器以基于选项列出数据馈送

.byPage() 返回异步可迭代迭代器以列出页面中的 blob。

使用 for await 语法的示例：

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);
}

使用 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();
}

使用 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>

参数

返回

返回异步可迭代迭代器以基于选项列出数据源凭据

.byPage() 返回异步可迭代迭代器以列出页面中的凭据。

使用 for await 语法的示例：

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);
}

使用 iter.next()的示例：

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

使用 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>

参数

返回

返回异步可迭代迭代器，以基于选项列出异常情况检测配置

.byPage() 返回异步可迭代迭代器，以列出页面中的异常情况检测配置。

使用 for await 语法的示例：

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);
}

使用 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();
}

使用 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>

参数

返回

返回异步可迭代迭代器以基于选项列出挂钩

.byPage() 返回异步可迭代迭代器以列出页面中的挂钩。

使用 for await 语法的示例：

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);
}

使用 iter.next()的示例：

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

使用 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>

参数

返回

刷新或重置给定数据馈送 ID 的数据馈送引入进度

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

参数

返回

更新给定配置 ID 的异常警报配置

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

参数

返回

根据数据馈送的 ID 更新数据馈送

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

参数

返回

更新给定 ID 的数据源凭据

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

参数

返回

更新给定配置 ID 的指标异常情况检测配置

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

参数

返回

更新给定挂钩 ID 的挂钩

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

参数

返回