@azure/arm-resourcegraph 5.0.0-beta.3 → 5.0.0-beta.5

package/review/arm-resourcegraph.api.md

@@ -1,217 +0,0 @@
-## API Report File for "@azure/arm-resourcegraph"
-
-> 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';
-
-// @public
-export type AuthorizationScopeFilter = "AtScopeAndBelow" | "AtScopeAndAbove" | "AtScopeExact" | "AtScopeAboveAndBelow";
-
-// @public
-export interface Column {
-    name: string;
-    type: ColumnDataType;
-}
-
-// @public
-export type ColumnDataType = "string" | "integer" | "number" | "boolean" | "object" | "datetime";
-
-// @public
-export interface DateTimeInterval {
-    end: Date;
-    start: Date;
-}
-
-// @public
-export interface ErrorDetails {
-    [property: string]: any;
-    code: string;
-    message: string;
-}
-
-// @public
-export interface ErrorModel {
-    code: string;
-    details?: ErrorDetails[];
-    message: string;
-}
-
-// @public
-export interface ErrorResponse {
-    error: ErrorModel;
-}
-
-// @public
-export interface Facet {
-    expression: string;
-    resultType: "FacetResult" | "FacetError";
-}
-
-// @public
-export interface FacetError extends Facet {
-    errors: ErrorDetails[];
-    resultType: "FacetError";
-}
-
-// @public
-export interface FacetRequest {
-    expression: string;
-    options?: FacetRequestOptions;
-}
-
-// @public
-export interface FacetRequestOptions {
-    filter?: string;
-    sortBy?: string;
-    sortOrder?: FacetSortOrder;
-    top?: number;
-}
-
-// @public
-export interface FacetResult extends Facet {
-    count: number;
-    data: Record<string, unknown>;
-    resultType: "FacetResult";
-    totalRecords: number;
-}
-
-// @public
-export type FacetSortOrder = "asc" | "desc";
-
-// @public (undocumented)
-export type FacetUnion = Facet | FacetResult | FacetError;
-
-// @public
-export function getContinuationToken(page: unknown): string | undefined;
-
-// @public
-export interface Operation {
-    display?: OperationDisplay;
-    name?: string;
-    origin?: string;
-}
-
-// @public
-export interface OperationDisplay {
-    description?: string;
-    operation?: string;
-    provider?: string;
-    resource?: string;
-}
-
-// @public
-export interface OperationListResult {
-    value?: Operation[];
-}
-
-// @public
-export interface Operations {
-    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
-}
-
-// @public
-export interface OperationsListOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type OperationsListResponse = OperationListResult;
-
-// @public
-export interface QueryRequest {
-    facets?: FacetRequest[];
-    managementGroups?: string[];
-    options?: QueryRequestOptions;
-    query: string;
-    subscriptions?: string[];
-}
-
-// @public
-export interface QueryRequestOptions {
-    allowPartialScopes?: boolean;
-    authorizationScopeFilter?: AuthorizationScopeFilter;
-    resultFormat?: ResultFormat;
-    skip?: number;
-    skipToken?: string;
-    top?: number;
-}
-
-// @public
-export interface QueryResponse {
-    count: number;
-    data: Record<string, unknown>;
-    facets?: FacetUnion[];
-    resultTruncated: ResultTruncated;
-    skipToken?: string;
-    totalRecords: number;
-}
-
-// @public (undocumented)
-export class ResourceGraphClient extends coreClient.ServiceClient {
-    // (undocumented)
-    $host: string;
-    constructor(credentials: coreAuth.TokenCredential, options?: ResourceGraphClientOptionalParams);
-    // (undocumented)
-    apiVersion: string;
-    // (undocumented)
-    operations: Operations;
-    resources(query: QueryRequest, options?: ResourcesOptionalParams): Promise<ResourcesResponse>;
-    resourcesHistory(request: ResourcesHistoryRequest, options?: ResourcesHistoryOptionalParams): Promise<ResourcesHistoryResponse>;
-}
-
-// @public
-export interface ResourceGraphClientOptionalParams extends coreClient.ServiceClientOptions {
-    $host?: string;
-    apiVersion?: string;
-    endpoint?: string;
-}
-
-// @public
-export interface ResourcesHistoryOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export interface ResourcesHistoryRequest {
-    managementGroups?: string[];
-    options?: ResourcesHistoryRequestOptions;
-    query?: string;
-    subscriptions?: string[];
-}
-
-// @public
-export interface ResourcesHistoryRequestOptions {
-    interval?: DateTimeInterval;
-    resultFormat?: ResultFormat;
-    skip?: number;
-    skipToken?: string;
-    top?: number;
-}
-
-// @public
-export type ResourcesHistoryResponse = Record<string, unknown>;
-
-// @public
-export interface ResourcesOptionalParams extends coreClient.OperationOptions {
-}
-
-// @public
-export type ResourcesResponse = QueryResponse;
-
-// @public
-export type ResultFormat = "table" | "objectArray";
-
-// @public
-export type ResultTruncated = "true" | "false";
-
-// @public
-export interface Table {
-    columns: Column[];
-    rows: Record<string, unknown>[][];
-}
-
-// (No @packageDocumentation comment for this package)
-
-```

package/rollup.config.js

@@ -1,122 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-
-import nodeResolve from "@rollup/plugin-node-resolve";
-import cjs from "@rollup/plugin-commonjs";
-import sourcemaps from "rollup-plugin-sourcemaps";
-import multiEntry from "@rollup/plugin-multi-entry";
-import json from "@rollup/plugin-json";
-
-import nodeBuiltins from "builtin-modules";
-
-// #region Warning Handler
-
-/**
- * A function that can determine whether a rollup warning should be ignored. If
- * the function returns `true`, then the warning will not be displayed.
- */
-
-function ignoreNiseSinonEval(warning) {
-  return (
-    warning.code === "EVAL" &&
-    warning.id &&
-      (warning.id.includes("node_modules/nise") ||
-        warning.id.includes("node_modules/sinon")) === true
-  );
-}
-
-function ignoreChaiCircularDependency(warning) {
-  return (
-    warning.code === "CIRCULAR_DEPENDENCY" &&
-    warning.importer && warning.importer.includes("node_modules/chai") === true
-  );
-}
-
-const warningInhibitors = [ignoreChaiCircularDependency, ignoreNiseSinonEval];
-
-/**
- * Construct a warning handler for the shared rollup configuration
- * that ignores certain warnings that are not relevant to testing.
- */
-function makeOnWarnForTesting() {
-  return (warning, warn) => {
-    // If every inhibitor returns false (i.e. no inhibitors), then show the warning
-    if (warningInhibitors.every((inhib) => !inhib(warning))) {
-      warn(warning);
-    }
-  };
-}
-
-// #endregion
-
-function makeBrowserTestConfig() {
-  const config = {
-    input: {
-      include: ["dist-esm/test/**/*.spec.js"],
-      exclude: ["dist-esm/test/**/node/**"]
-    },
-    output: {
-      file: `dist-test/index.browser.js`,
-      format: "umd",
-      sourcemap: true
-    },
-    preserveSymlinks: false,
-    plugins: [
-      multiEntry({ exports: false }),
-      nodeResolve({
-        mainFields: ["module", "browser"]
-      }),
-      cjs(),
-      json(),
-      sourcemaps()
-      //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
-    ],
-    onwarn: makeOnWarnForTesting(),
-    // Disable tree-shaking of test code.  In rollup-plugin-node-resolve@5.0.0,
-    // rollup started respecting the "sideEffects" field in package.json.  Since
-    // our package.json sets "sideEffects=false", this also applies to test
-    // code, which causes all tests to be removed by tree-shaking.
-    treeshake: false
-  };
-
-  return config;
-}
-
-const defaultConfigurationOptions = {
-  disableBrowserBundle: false
-};
-
-export function makeConfig(pkg, options) {
-  options = {
-    ...defaultConfigurationOptions,
-    ...(options || {})
-  };
-
-  const baseConfig = {
-    // Use the package's module field if it has one
-    input: pkg["module"] || "dist-esm/src/index.js",
-    external: [
-      ...nodeBuiltins,
-      ...Object.keys(pkg.dependencies),
-      ...Object.keys(pkg.devDependencies)
-    ],
-    output: { file: "dist/index.js", format: "cjs", sourcemap: true },
-    preserveSymlinks: false,
-    plugins: [sourcemaps(), nodeResolve()]
-  };
-
-  const config = [baseConfig];
-
-  if (!options.disableBrowserBundle) {
-    config.push(makeBrowserTestConfig());
-  }
-
-  return config;
-}
-
-export default makeConfig(require("./package.json"));

package/src/index.ts

@@ -1,13 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-
-/// <reference lib="esnext.asynciterable" />
-export { getContinuationToken } from "./pagingHelper";
-export * from "./models";
-export { ResourceGraphClient } from "./resourceGraphClient";
-export * from "./operationsInterfaces";

package/src/models/index.ts

@@ -1,261 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-
-import * as coreClient from "@azure/core-client";
-
-export type FacetUnion = Facet | FacetResult | FacetError;
-
-/** Describes a query to be executed. */
-export interface QueryRequest {
-  /** Azure subscriptions against which to execute the query. */
-  subscriptions?: string[];
-  /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
-  managementGroups?: string[];
-  /** The resources query. */
-  query: string;
-  /** The query evaluation options */
-  options?: QueryRequestOptions;
-  /** An array of facet requests to be computed against the query result. */
-  facets?: FacetRequest[];
-}
-
-/** The options for query evaluation */
-export interface QueryRequestOptions {
-  /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
-  skipToken?: string;
-  /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
-  top?: number;
-  /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
-  skip?: number;
-  /** Defines in which format query result returned. */
-  resultFormat?: ResultFormat;
-  /** Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits. */
-  allowPartialScopes?: boolean;
-  /** Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes. */
-  authorizationScopeFilter?: AuthorizationScopeFilter;
-}
-
-/** A request to compute additional statistics (facets) over the query results. */
-export interface FacetRequest {
-  /** The column or list of columns to summarize by */
-  expression: string;
-  /** The options for facet evaluation */
-  options?: FacetRequestOptions;
-}
-
-/** The options for facet evaluation */
-export interface FacetRequestOptions {
-  /** The column name or query expression to sort on. Defaults to count if not present. */
-  sortBy?: string;
-  /** The sorting order by the selected column (count by default). */
-  sortOrder?: FacetSortOrder;
-  /** Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting. */
-  filter?: string;
-  /** The maximum number of facet rows that should be returned. */
-  top?: number;
-}
-
-/** Query result. */
-export interface QueryResponse {
-  /** Number of total records matching the query. */
-  totalRecords: number;
-  /** Number of records returned in the current response. In the case of paging, this is the number of records in the current page. */
-  count: number;
-  /** Indicates whether the query results are truncated. */
-  resultTruncated: ResultTruncated;
-  /** When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data. */
-  skipToken?: string;
-  /** Query output in JObject array or Table format. */
-  data: Record<string, unknown>;
-  /** Query facets. */
-  facets?: FacetUnion[];
-}
-
-/** A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError. */
-export interface Facet {
-  /** Polymorphic discriminator, which specifies the different types this object can be */
-  resultType: "FacetResult" | "FacetError";
-  /** Facet expression, same as in the corresponding facet request. */
-  expression: string;
-}
-
-/** An error response from the API. */
-export interface ErrorResponse {
-  /** Error information. */
-  error: ErrorModel;
-}
-
-/** Error details. */
-export interface ErrorModel {
-  /** Error code identifying the specific error. */
-  code: string;
-  /** A human readable error message. */
-  message: string;
-  /** Error details */
-  details?: ErrorDetails[];
-}
-
-/** Error details. */
-export interface ErrorDetails {
-  /** Describes unknown properties. The value of an unknown property can be of "any" type. */
-  [property: string]: any;
-  /** Error code identifying the specific error. */
-  code: string;
-  /** A human readable error message. */
-  message: string;
-}
-
-/** Result of the request to list Resource Graph operations. It contains a list of operations and a URL link to get the next set of results. */
-export interface OperationListResult {
-  /** List of Resource Graph operations supported by the Resource Graph resource provider. */
-  value?: Operation[];
-}
-
-/** Resource Graph REST API operation definition. */
-export interface Operation {
-  /** Operation name: {provider}/{resource}/{operation} */
-  name?: string;
-  /** Display metadata associated with the operation. */
-  display?: OperationDisplay;
-  /** The origin of operations. */
-  origin?: string;
-}
-
-/** Display metadata associated with the operation. */
-export interface OperationDisplay {
-  /** Service provider: Microsoft Resource Graph. */
-  provider?: string;
-  /** Resource on which the operation is performed etc. */
-  resource?: string;
-  /** Type of operation: get, read, delete, etc. */
-  operation?: string;
-  /** Description for the operation. */
-  description?: string;
-}
-
-/** Describes a history request to be executed. */
-export interface ResourcesHistoryRequest {
-  /** Azure subscriptions against which to execute the query. */
-  subscriptions?: string[];
-  /** The resources query. */
-  query?: string;
-  /** The history request evaluation options */
-  options?: ResourcesHistoryRequestOptions;
-  /** Azure management groups against which to execute the query. Example: [ 'mg1', 'mg2' ] */
-  managementGroups?: string[];
-}
-
-/** The options for history request evaluation */
-export interface ResourcesHistoryRequestOptions {
-  /** The time interval used to fetch history. */
-  interval?: DateTimeInterval;
-  /** The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present. */
-  top?: number;
-  /** The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present. */
-  skip?: number;
-  /** Continuation token for pagination, capturing the next page size and offset, as well as the context of the query. */
-  skipToken?: string;
-  /** Defines in which format query result returned. */
-  resultFormat?: ResultFormat;
-}
-
-/** An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. `[start, end)`. */
-export interface DateTimeInterval {
-  /** A datetime indicating the inclusive/closed start of the time interval, i.e. `[`**`start`**`, end)`. Specifying a `start` that occurs chronologically after `end` will result in an error. */
-  start: Date;
-  /** A datetime indicating the exclusive/open end of the time interval, i.e. `[start, `**`end`**`)`. Specifying an `end` that occurs chronologically before `start` will result in an error. */
-  end: Date;
-}
-
-/** Query output in tabular format. */
-export interface Table {
-  /** Query result column descriptors. */
-  columns: Column[];
-  /** Query result rows. */
-  rows: Record<string, unknown>[][];
-}
-
-/** Query result column descriptor. */
-export interface Column {
-  /** Column name. */
-  name: string;
-  /** Column data type. */
-  type: ColumnDataType;
-}
-
-/** Successfully executed facet containing additional statistics on the response of a query. */
-export interface FacetResult extends Facet {
-  /** Polymorphic discriminator, which specifies the different types this object can be */
-  resultType: "FacetResult";
-  /** Number of total records in the facet results. */
-  totalRecords: number;
-  /** Number of records returned in the facet response. */
-  count: number;
-  /** A JObject array or Table containing the desired facets. Only present if the facet is valid. */
-  data: Record<string, unknown>;
-}
-
-/** A facet whose execution resulted in an error. */
-export interface FacetError extends Facet {
-  /** Polymorphic discriminator, which specifies the different types this object can be */
-  resultType: "FacetError";
-  /** An array containing detected facet errors with details. */
-  errors: ErrorDetails[];
-}
-
-/** Defines values for ResultFormat. */
-export type ResultFormat = "table" | "objectArray";
-/** Defines values for AuthorizationScopeFilter. */
-export type AuthorizationScopeFilter =
-  | "AtScopeAndBelow"
-  | "AtScopeAndAbove"
-  | "AtScopeExact"
-  | "AtScopeAboveAndBelow";
-/** Defines values for FacetSortOrder. */
-export type FacetSortOrder = "asc" | "desc";
-/** Defines values for ResultTruncated. */
-export type ResultTruncated = "true" | "false";
-/** Defines values for ColumnDataType. */
-export type ColumnDataType =
-  | "string"
-  | "integer"
-  | "number"
-  | "boolean"
-  | "object"
-  | "datetime";
-
-/** Optional parameters. */
-export interface ResourcesOptionalParams extends coreClient.OperationOptions {}
-
-/** Contains response data for the resources operation. */
-export type ResourcesResponse = QueryResponse;
-
-/** Optional parameters. */
-export interface ResourcesHistoryOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the resourcesHistory operation. */
-export type ResourcesHistoryResponse = Record<string, unknown>;
-
-/** Optional parameters. */
-export interface OperationsListOptionalParams
-  extends coreClient.OperationOptions {}
-
-/** Contains response data for the list operation. */
-export type OperationsListResponse = OperationListResult;
-
-/** Optional parameters. */
-export interface ResourceGraphClientOptionalParams
-  extends coreClient.ServiceClientOptions {
-  /** server parameter */
-  $host?: string;
-  /** Api Version */
-  apiVersion?: string;
-  /** Overrides client endpoint. */
-  endpoint?: string;
-}