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

package/types/arm-resourcegraph.d.ts

@@ -0,0 +1,284 @@
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+/** Defines values for AuthorizationScopeFilter. */
+export declare type AuthorizationScopeFilter = "AtScopeAndBelow" | "AtScopeAndAbove" | "AtScopeExact" | "AtScopeAboveAndBelow";
+
+/** Query result column descriptor. */
+export declare interface Column {
+    /** Column name. */
+    name: string;
+    /** Column data type. */
+    type: ColumnDataType;
+}
+
+/** Defines values for ColumnDataType. */
+export declare type ColumnDataType = "string" | "integer" | "number" | "boolean" | "object" | "datetime";
+
+/** An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. `[start, end)`. */
+export declare 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;
+}
+
+/** Error details. */
+export declare 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;
+}
+
+/** Error details. */
+export declare 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. */
+export declare interface ErrorResponse {
+    /** Error information. */
+    error: ErrorModel;
+}
+
+/** A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError. */
+export declare 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;
+}
+
+/** A facet whose execution resulted in an error. */
+export declare 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[];
+};
+
+/** A request to compute additional statistics (facets) over the query results. */
+export declare 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 declare 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;
+}
+
+/** Successfully executed facet containing additional statistics on the response of a query. */
+export declare 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 FacetSortOrder. */
+export declare type FacetSortOrder = "asc" | "desc";
+
+export declare type FacetUnion = Facet | FacetResult | FacetError;
+
+/** Resource Graph REST API operation definition. */
+export declare 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 declare 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;
+}
+
+/** 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 declare interface OperationListResult {
+    /** List of Resource Graph operations supported by the Resource Graph resource provider. */
+    value?: Operation[];
+}
+
+/** Interface representing a Operations. */
+export declare interface Operations {
+    /**
+     * Lists all of the available REST API operations.
+     * @param options The options parameters.
+     */
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+/** Optional parameters. */
+export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type OperationsListResponse = OperationListResult;
+
+/** Describes a query to be executed. */
+export declare 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 declare 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;
+}
+
+/** Query result. */
+export declare 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[];
+}
+
+export declare class ResourceGraphClient extends coreClient.ServiceClient {
+    $host: string;
+    apiVersion: string;
+    /**
+     * Initializes a new instance of the ResourceGraphClient class.
+     * @param credentials Subscription credentials which uniquely identify client subscription.
+     * @param options The parameter options
+     */
+    constructor(credentials: coreAuth.TokenCredential, options?: ResourceGraphClientOptionalParams);
+    /**
+     * Queries the resources managed by Azure Resource Manager for scopes specified in the request.
+     * @param query Request specifying query and its options.
+     * @param options The options parameters.
+     */
+    resources(query: QueryRequest, options?: ResourcesOptionalParams): Promise<ResourcesResponse>;
+    /**
+     * List all snapshots of a resource for a given time interval.
+     * @param request Request specifying the query and its options.
+     * @param options The options parameters.
+     */
+    resourcesHistory(request: ResourcesHistoryRequest, options?: ResourcesHistoryOptionalParams): Promise<ResourcesHistoryResponse>;
+    operations: Operations;
+}
+
+/** Optional parameters. */
+export declare interface ResourceGraphClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** server parameter */
+    $host?: string;
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/** Optional parameters. */
+export declare interface ResourcesHistoryOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Describes a history request to be executed. */
+export declare 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 declare 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;
+}
+
+/** Contains response data for the resourcesHistory operation. */
+export declare type ResourcesHistoryResponse = Record<string, unknown>;
+
+/** Optional parameters. */
+export declare interface ResourcesOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the resources operation. */
+export declare type ResourcesResponse = QueryResponse;
+
+/** Defines values for ResultFormat. */
+export declare type ResultFormat = "table" | "objectArray";
+
+/** Defines values for ResultTruncated. */
+export declare type ResultTruncated = "true" | "false";
+
+/** Query output in tabular format. */
+export declare interface Table {
+    /** Query result column descriptors. */
+    columns: Column[];
+    /** Query result rows. */
+    rows: Record<string, unknown>[][];
+}
+
+export { }

package/types/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.19.4"
+    }
+  ]
+}