@azure/arm-dependencymap 1.0.0-beta.1

package/review/arm-dependencymap.api.md

@@ -0,0 +1,371 @@
+## API Report File for "@azure/arm-dependencymap"
+
+> 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 type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface DateTimeFilter {
+    endDateTimeUtc?: Date;
+    startDateTimeUtc?: Date;
+}
+
+// @public (undocumented)
+export class DependencyMapClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: DependencyMapClientOptionalParams);
+    readonly discoverySources: DiscoverySourcesOperations;
+    readonly maps: MapsOperations;
+    readonly operations: OperationsOperations;
+    readonly pipeline: Pipeline;
+}
+
+// @public
+export interface DependencyMapClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface DependencyMapVisualizationFilter {
+    dateTime?: DateTimeFilter;
+    processNameFilter?: ProcessNameFilter;
+}
+
+// @public
+export interface DiscoverySourceResource extends TrackedResource {
+    properties?: DiscoverySourceResourcePropertiesUnion;
+}
+
+// @public
+export interface DiscoverySourceResourceProperties {
+    readonly provisioningState?: ProvisioningState;
+    sourceId: string;
+    sourceType: SourceType;
+}
+
+// @public
+export type DiscoverySourceResourcePropertiesUnion = OffAzureDiscoverySourceResourceProperties | DiscoverySourceResourceProperties;
+
+// @public
+export interface DiscoverySourceResourceTagsUpdate {
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface DiscoverySourcesCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DiscoverySourcesDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface DiscoverySourcesGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface DiscoverySourcesListByMapsResourceOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface DiscoverySourcesOperations {
+    createOrUpdate: (resourceGroupName: string, mapName: string, sourceName: string, resource: DiscoverySourceResource, options?: DiscoverySourcesCreateOrUpdateOptionalParams) => PollerLike<OperationState<DiscoverySourceResource>, DiscoverySourceResource>;
+    delete: (resourceGroupName: string, mapName: string, sourceName: string, options?: DiscoverySourcesDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, mapName: string, sourceName: string, options?: DiscoverySourcesGetOptionalParams) => Promise<DiscoverySourceResource>;
+    listByMapsResource: (resourceGroupName: string, mapName: string, options?: DiscoverySourcesListByMapsResourceOptionalParams) => PagedAsyncIterableIterator<DiscoverySourceResource>;
+    update: (resourceGroupName: string, mapName: string, sourceName: string, properties: DiscoverySourceResourceTagsUpdate, options?: DiscoverySourcesUpdateOptionalParams) => PollerLike<OperationState<DiscoverySourceResource>, DiscoverySourceResource>;
+}
+
+// @public
+export interface DiscoverySourcesUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @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 ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface ExportDependenciesRequest {
+    filters?: DependencyMapVisualizationFilter;
+    focusedMachineId: string;
+}
+
+// @public
+export interface GetConnectionsForProcessOnFocusedMachineRequest {
+    filters?: DependencyMapVisualizationFilter;
+    focusedMachineId: string;
+    processIdOnFocusedMachine: string;
+}
+
+// @public
+export interface GetConnectionsWithConnectedMachineForFocusedMachineRequest {
+    connectedMachineId: string;
+    filters?: DependencyMapVisualizationFilter;
+    focusedMachineId: string;
+}
+
+// @public
+export interface GetDependencyViewForFocusedMachineRequest {
+    filters?: DependencyMapVisualizationFilter;
+    focusedMachineId: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownProcessNameFilterOperator {
+    Contains = "contains",
+    NotContains = "notContains"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Accepted = "Accepted",
+    Canceled = "Canceled",
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Provisioning = "Provisioning",
+    Succeeded = "Succeeded",
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownSourceType {
+    OffAzure = "OffAzure"
+}
+
+// @public
+export enum KnownVersions {
+    V20250131Preview = "2025-01-31-preview"
+}
+
+// @public
+export interface MapsCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MapsDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MapsExportDependenciesOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MapsGetConnectionsForProcessOnFocusedMachineOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MapsGetConnectionsWithConnectedMachineForFocusedMachineOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MapsGetDependencyViewForFocusedMachineOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface MapsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface MapsListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface MapsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface MapsOperations {
+    createOrUpdate: (resourceGroupName: string, mapName: string, resource: MapsResource, options?: MapsCreateOrUpdateOptionalParams) => PollerLike<OperationState<MapsResource>, MapsResource>;
+    delete: (resourceGroupName: string, mapName: string, options?: MapsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    exportDependencies: (resourceGroupName: string, mapName: string, body: ExportDependenciesRequest, options?: MapsExportDependenciesOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, mapName: string, options?: MapsGetOptionalParams) => Promise<MapsResource>;
+    getConnectionsForProcessOnFocusedMachine: (resourceGroupName: string, mapName: string, body: GetConnectionsForProcessOnFocusedMachineRequest, options?: MapsGetConnectionsForProcessOnFocusedMachineOptionalParams) => PollerLike<OperationState<void>, void>;
+    getConnectionsWithConnectedMachineForFocusedMachine: (resourceGroupName: string, mapName: string, body: GetConnectionsWithConnectedMachineForFocusedMachineRequest, options?: MapsGetConnectionsWithConnectedMachineForFocusedMachineOptionalParams) => PollerLike<OperationState<void>, void>;
+    getDependencyViewForFocusedMachine: (resourceGroupName: string, mapName: string, body: GetDependencyViewForFocusedMachineRequest, options?: MapsGetDependencyViewForFocusedMachineOptionalParams) => PollerLike<OperationState<void>, void>;
+    listByResourceGroup: (resourceGroupName: string, options?: MapsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<MapsResource>;
+    listBySubscription: (options?: MapsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<MapsResource>;
+    update: (resourceGroupName: string, mapName: string, properties: MapsResourceTagsUpdate, options?: MapsUpdateOptionalParams) => PollerLike<OperationState<MapsResource>, MapsResource>;
+}
+
+// @public
+export interface MapsResource extends TrackedResource {
+    properties?: MapsResourceProperties;
+}
+
+// @public
+export interface MapsResourceProperties {
+    readonly provisioningState?: ProvisioningState;
+}
+
+// @public
+export interface MapsResourceTagsUpdate {
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface MapsUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OffAzureDiscoverySourceResourceProperties extends DiscoverySourceResourceProperties {
+    sourceType: "OffAzure";
+}
+
+// @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
+export interface ProcessNameFilter {
+    operator: ProcessNameFilterOperator;
+    processNames: string[];
+}
+
+// @public
+export type ProcessNameFilterOperator = string;
+
+// @public
+export type ProvisioningState = 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: DependencyMapClient, 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 type SourceType = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: Record<string, string>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```