@azure/arm-resourcegraph 4.0.0 → 5.0.0-beta.1

package/src/models/index.ts

@@ -6,404 +6,255 @@
  * Changes may cause incorrect behavior and will be lost if the code is regenerated.
  */
 
-import { BaseResource, CloudError, AzureServiceClientOptions } from "@azure/ms-rest-azure-js";
-import * as msRest from "@azure/ms-rest-js";
+import * as coreClient from "@azure/core-client";
 
-export { BaseResource, CloudError };
+export type FacetUnion = Facet | FacetResult | FacetError;
 
-/**
- * The options for query evaluation
- */
+/** 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.
-   */
+  /** 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.
-   */
+  /** 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.
-   */
+  /** 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. Possible values include: 'table',
-   * 'objectArray'. Default value: 'objectArray'.
-   */
+  /** 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. Default
-   * value: false.
-   */
+  /** 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;
 }
 
-/**
- * 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). Possible values include: 'asc',
-   * 'desc'. Default value: 'desc'.
-   */
-  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;
-}
-
-/**
- * A request to compute additional statistics (facets) over the query results.
- */
+/** A request to compute additional statistics (facets) over the query results. */
 export interface FacetRequest {
-  /**
-   * The column or list of columns to summarize by
-   */
+  /** The column or list of columns to summarize by */
   expression: string;
-  /**
-   * The options for facet evaluation
-   */
+  /** The options for facet evaluation */
   options?: FacetRequestOptions;
 }
 
-/**
- * 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[];
-}
-
-/**
- * Contains the possible cases for Facet.
- */
-export type FacetUnion = Facet | FacetResult | FacetError;
-
-/**
- * A facet containing additional statistics on the response of a query. Can be either FacetResult
- * or FacetError.
- */
-export interface Facet {
-  /**
-   * Polymorphic Discriminator
-   */
-  resultType: "Facet";
-  /**
-   * Facet expression, same as in the corresponding facet request.
-   */
-  expression: string;
+/** 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.
- */
+/** Query result. */
 export interface QueryResponse {
-  /**
-   * Number of total records matching the query.
-   */
+  /** 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.
-   */
+  /** 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. Possible values include: 'true', 'false'
-   */
+  /** 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.
-   */
+  /** 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: any;
-  /**
-   * Query facets.
-   */
+  /** Query output in JObject array or Table format. */
+  data: Record<string, unknown>;
+  /** Query facets. */
   facets?: FacetUnion[];
 }
 
-/**
- * Query result column descriptor.
- */
-export interface Column {
-  /**
-   * Column name.
-   */
-  name: string;
-  /**
-   * Column data type. Possible values include: 'string', 'integer', 'number', 'boolean', 'object'
-   */
-  type: ColumnDataType;
+/** 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;
 }
 
-/**
- * Query output in tabular format.
- */
-export interface Table {
-  /**
-   * Query result column descriptors.
-   */
-  columns: Column[];
-  /**
-   * Query result rows.
-   */
-  rows: any[][];
+/** An error response from the API. */
+export interface ErrorResponse {
+  /** Error information. */
+  error: ErrorModel;
 }
 
-/**
- * Successfully executed facet containing additional statistics on the response of a query.
- */
-export interface FacetResult {
-  /**
-   * Polymorphic Discriminator
-   */
-  resultType: "FacetResult";
-  /**
-   * Facet expression, same as in the corresponding facet request.
-   */
-  expression: string;
-  /**
-   * 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: any;
+/** Error details. */
+export interface ErrorModel {
+  /** Error code identifying the specific error. */
+  code: string;
+  /** A human readable error message. */
+  message: string;
+  /** Error details */
+  details?: ErrorDetails[];
 }
 
-/**
- * An interface representing ErrorDetails.
- * @summary Error details.
- */
+/** Error details. */
 export interface ErrorDetails {
-  /**
-   * Error code identifying the specific error.
-   */
+  /** 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.
-   */
+  /** A human readable error message. */
   message: string;
-  /**
-   * Describes unknown properties. The value of an unknown property can be of "any" type.
-   */
-  [property: string]: any;
 }
 
-/**
- * A facet whose execution resulted in an error.
- */
-export interface FacetError {
-  /**
-   * Polymorphic Discriminator
-   */
-  resultType: "FacetError";
-  /**
-   * Facet expression, same as in the corresponding facet request.
-   */
-  expression: string;
-  /**
-   * An array containing detected facet errors with details.
-   */
-  errors: ErrorDetails[];
+/** 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[];
 }
 
-/**
- * Error details.
- * @summary Error info.
- */
-export interface ErrorModel {
-  /**
-   * Error code identifying the specific error.
-   */
-  code: string;
-  /**
-   * A human readable error message.
-   */
-  message: string;
-  /**
-   * Error details
-   */
-  details?: ErrorDetails[];
-}
-
-/**
- * An error response from the API.
- * @summary Error response.
- */
-export interface ErrorResponse {
-  /**
-   * Error information.
-   */
-  error: ErrorModel;
+/** 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.
- */
+/** Display metadata associated with the operation. */
 export interface OperationDisplay {
-  /**
-   * Service provider: Microsoft Resource Graph.
-   */
+  /** Service provider: Microsoft Resource Graph. */
   provider?: string;
-  /**
-   * Resource on which the operation is performed etc.
-   */
+  /** Resource on which the operation is performed etc. */
   resource?: string;
-  /**
-   * Type of operation: get, read, delete, etc.
-   */
+  /** Type of operation: get, read, delete, etc. */
   operation?: string;
-  /**
-   * Description for the operation.
-   */
+  /** Description for the operation. */
   description?: string;
 }
 
-/**
- * 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;
+/** 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[];
 }
 
-/**
- * An interface representing ResourceGraphClientOptions.
- */
-export interface ResourceGraphClientOptions extends AzureServiceClientOptions {
-  baseUri?: 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;
 }
 
-/**
- * @interface
- * 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.
- * @extends Array<Operation>
- */
-export interface OperationListResult extends Array<Operation> {
+/** 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;
 }
 
-/**
- * Defines values for ResultFormat.
- * Possible values include: 'table', 'objectArray'
- * @readonly
- * @enum {string}
- */
-export type ResultFormat = 'table' | 'objectArray';
+/** Query output in tabular format. */
+export interface Table {
+  /** Query result column descriptors. */
+  columns: Column[];
+  /** Query result rows. */
+  rows: Record<string, unknown>[][];
+}
 
-/**
- * Defines values for FacetSortOrder.
- * Possible values include: 'asc', 'desc'
- * @readonly
- * @enum {string}
- */
-export type FacetSortOrder = 'asc' | 'desc';
+/** Query result column descriptor. */
+export interface Column {
+  /** Column name. */
+  name: string;
+  /** Column data type. */
+  type: ColumnDataType;
+}
 
-/**
- * Defines values for ResultTruncated.
- * Possible values include: 'true', 'false'
- * @readonly
- * @enum {string}
- */
-export type ResultTruncated = 'true' | 'false';
+/** Successfully executed facet containing additional statistics on the response of a query. */
+export type FacetResult = 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>;
+};
 
-/**
- * Defines values for ColumnDataType.
- * Possible values include: 'string', 'integer', 'number', 'boolean', 'object'
- * @readonly
- * @enum {string}
- */
-export type ColumnDataType = 'string' | 'integer' | 'number' | 'boolean' | 'object';
+/** A facet whose execution resulted in an error. */
+export type FacetError = 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";
 
-/**
- * Contains response data for the resources operation.
- */
-export type ResourcesResponse = QueryResponse & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
+/** Optional parameters. */
+export interface ResourcesOptionalParams extends coreClient.OperationOptions {}
 
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: QueryResponse;
-    };
-};
+/** Contains response data for the resources operation. */
+export type ResourcesResponse = QueryResponse;
 
-/**
- * Contains response data for the list operation.
- */
-export type OperationsListResponse = OperationListResult & {
-  /**
-   * The underlying HTTP response.
-   */
-  _response: msRest.HttpResponse & {
-      /**
-       * The response body as text (string format)
-       */
-      bodyAsText: string;
+/** Optional parameters. */
+export interface ResourcesHistoryOptionalParams
+  extends coreClient.OperationOptions {}
 
-      /**
-       * The response body as parsed JSON or XML
-       */
-      parsedBody: OperationListResult;
-    };
-};
+/** 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;
+}