@azure/arm-impactreporting 1.0.0-beta.1

package/review/arm-impactreporting.api.md

@@ -0,0 +1,497 @@
+## API Report File for "@azure/arm-impactreporting"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PathUncheckedResponse } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { PollerLike } from '@azure/core-lro';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface ClientIncidentDetails {
+    clientIncidentId?: string;
+    clientIncidentSource?: IncidentSource;
+}
+
+// @public
+export type ConfidenceLevel = string;
+
+// @public
+export interface Connectivity {
+    port?: number;
+    protocol?: Protocol;
+    source?: SourceOrTarget;
+    target?: SourceOrTarget;
+}
+
+// @public
+export interface Connector extends ProxyResource {
+    properties?: ConnectorProperties;
+}
+
+// @public
+export interface ConnectorProperties {
+    readonly connectorId: string;
+    connectorType: Platform;
+    readonly lastRunTimeStamp: Date;
+    readonly provisioningState?: ProvisioningState;
+    readonly tenantId: string;
+}
+
+// @public
+export interface ConnectorsCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface ConnectorsDeleteOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ConnectorsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ConnectorsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ConnectorsOperations {
+    createOrUpdate: (connectorName: string, resource: Connector, options?: ConnectorsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Connector>, Connector>;
+    delete: (connectorName: string, options?: ConnectorsDeleteOptionalParams) => Promise<void>;
+    get: (connectorName: string, options?: ConnectorsGetOptionalParams) => Promise<Connector>;
+    listBySubscription: (options?: ConnectorsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Connector>;
+    update: (connectorName: string, properties: ConnectorUpdate, options?: ConnectorsUpdateOptionalParams) => Promise<Connector>;
+}
+
+// @public
+export interface ConnectorsUpdateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ConnectorUpdate {
+    properties?: ConnectorUpdateProperties;
+}
+
+// @public
+export interface ConnectorUpdateProperties {
+    connectorType?: Platform;
+}
+
+// @public
+export interface Content {
+    description: string;
+    title: string;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, any>;
+    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 ErrorDetailProperties {
+    errorCode?: string;
+    errorMessage?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface ExpectedValueRange {
+    max: number;
+    min: number;
+}
+
+// @public
+export interface ImpactCategoriesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface ImpactCategoriesListBySubscriptionOptionalParams extends OperationOptions {
+    categoryName?: string;
+}
+
+// @public
+export interface ImpactCategoriesOperations {
+    get: (impactCategoryName: string, options?: ImpactCategoriesGetOptionalParams) => Promise<ImpactCategory>;
+    listBySubscription: (resourceType: string, options?: ImpactCategoriesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ImpactCategory>;
+}
+
+// @public
+export interface ImpactCategory extends ProxyResource {
+    properties?: ImpactCategoryProperties;
+}
+
+// @public
+export interface ImpactCategoryProperties {
+    categoryId: string;
+    description?: string;
+    parentCategoryId?: string;
+    readonly provisioningState?: ProvisioningState;
+    requiredImpactProperties?: RequiredImpactProperties[];
+}
+
+// @public (undocumented)
+export class ImpactClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: ImpactClientOptionalParams);
+    readonly connectors: ConnectorsOperations;
+    readonly impactCategories: ImpactCategoriesOperations;
+    readonly insights: InsightsOperations;
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+    readonly workloadImpacts: WorkloadImpactsOperations;
+}
+
+// @public
+export interface ImpactClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface ImpactDetails {
+    endTime?: Date;
+    impactedResourceId: string;
+    impactId: string;
+    startTime: Date;
+}
+
+// @public
+export type IncidentSource = string;
+
+// @public
+export interface Insight extends ProxyResource {
+    properties?: InsightProperties;
+}
+
+// @public
+export interface InsightProperties {
+    additionalDetails?: Record<string, any>;
+    category: string;
+    content: Content;
+    eventId?: string;
+    eventTime?: Date;
+    groupId?: string;
+    impact: ImpactDetails;
+    insightUniqueId: string;
+    readonly provisioningState?: ProvisioningState;
+    status?: string;
+}
+
+// @public
+export interface InsightsCreateOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface InsightsDeleteOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface InsightsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface InsightsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface InsightsOperations {
+    create: (workloadImpactName: string, insightName: string, resource: Insight, options?: InsightsCreateOptionalParams) => Promise<Insight>;
+    delete: (workloadImpactName: string, insightName: string, options?: InsightsDeleteOptionalParams) => Promise<void>;
+    get: (workloadImpactName: string, insightName: string, options?: InsightsGetOptionalParams) => Promise<Insight>;
+    listBySubscription: (workloadImpactName: string, options?: InsightsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Insight>;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownConfidenceLevel {
+    High = "High",
+    Low = "Low",
+    Medium = "Medium"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownIncidentSource {
+    AzureDevops = "AzureDevops",
+    ICM = "ICM",
+    Jira = "Jira",
+    Other = "Other",
+    ServiceNow = "ServiceNow"
+}
+
+// @public
+export enum KnownMetricUnit {
+    Bytes = "Bytes",
+    ByteSeconds = "ByteSeconds",
+    BytesPerSecond = "BytesPerSecond",
+    Cores = "Cores",
+    Count = "Count",
+    CountPerSecond = "CountPerSecond",
+    MilliCores = "MilliCores",
+    MilliSeconds = "MilliSeconds",
+    NanoCores = "NanoCores",
+    Other = "Other",
+    Percent = "Percent",
+    Seconds = "Seconds"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownPlatform {
+    AzureMonitor = "AzureMonitor"
+}
+
+// @public
+export enum KnownProtocol {
+    FTP = "FTP",
+    Http = "HTTP",
+    Https = "HTTPS",
+    Other = "Other",
+    RDP = "RDP",
+    SSH = "SSH",
+    TCP = "TCP",
+    UDP = "UDP"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownToolset {
+    Ansible = "Ansible",
+    ARM = "ARM",
+    Chef = "Chef",
+    Other = "Other",
+    Portal = "Portal",
+    Puppet = "Puppet",
+    SDK = "SDK",
+    Shell = "Shell",
+    Terraform = "Terraform"
+}
+
+// @public
+export enum KnownVersions {
+    V20240501Preview = "2024-05-01-preview"
+}
+
+// @public
+export type MetricUnit = string;
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+interface Performance_2 {
+    actual?: number;
+    expected?: number;
+    expectedValueRange?: ExpectedValueRange;
+    metricName?: string;
+    unit?: MetricUnit;
+}
+export { Performance_2 as Performance }
+
+// @public
+export type Platform = string;
+
+// @public
+export type Protocol = string;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface RequiredImpactProperties {
+    allowedValues?: string[];
+    name: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: ImpactClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+
+// @public (undocumented)
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    abortSignal?: AbortSignalLike;
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SourceOrTarget {
+    azureResourceId?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type Toolset = string;
+
+// @public
+export interface Workload {
+    context?: string;
+    toolset?: Toolset;
+}
+
+// @public
+export interface WorkloadImpact extends ProxyResource {
+    properties?: WorkloadImpactProperties;
+}
+
+// @public
+export interface WorkloadImpactProperties {
+    additionalProperties?: Record<string, any>;
+    armCorrelationIds?: string[];
+    clientIncidentDetails?: ClientIncidentDetails;
+    confidenceLevel?: ConfidenceLevel;
+    connectivity?: Connectivity;
+    endDateTime?: Date;
+    errorDetails?: ErrorDetailProperties;
+    impactCategory: string;
+    impactDescription?: string;
+    impactedResourceId: string;
+    impactGroupId?: string;
+    readonly impactUniqueId?: string;
+    performance?: Performance_2[];
+    readonly provisioningState?: ProvisioningState;
+    readonly reportedTimeUtc?: Date;
+    startDateTime: Date;
+    workload?: Workload;
+}
+
+// @public
+export interface WorkloadImpactsCreateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface WorkloadImpactsDeleteOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface WorkloadImpactsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface WorkloadImpactsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface WorkloadImpactsOperations {
+    create: (workloadImpactName: string, resource: WorkloadImpact, options?: WorkloadImpactsCreateOptionalParams) => PollerLike<OperationState<WorkloadImpact>, WorkloadImpact>;
+    delete: (workloadImpactName: string, options?: WorkloadImpactsDeleteOptionalParams) => Promise<void>;
+    get: (workloadImpactName: string, options?: WorkloadImpactsGetOptionalParams) => Promise<WorkloadImpact>;
+    listBySubscription: (options?: WorkloadImpactsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<WorkloadImpact>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```