@azure/arm-resourcegraph package

Classes

ResourceGraphClient

Interfaces

DateTimeInterval	An interval in time specifying the date and time for the inclusive start and exclusive end, i.e. [start, end).
ErrorDetails	Error details.
ErrorFieldContract	Error Field contract.
ErrorModel	Error details.
ErrorResponse	An error response from the API.
Facet	A facet containing additional statistics on the response of a query. Can be either FacetResult or FacetError.
FacetError	A facet whose execution resulted in an error.
FacetRequest	A request to compute additional statistics (facets) over the query results.
FacetRequestOptions	The options for facet evaluation
FacetResult	Successfully executed facet containing additional statistics on the response of a query.
GraphQueryCreateOrUpdateOptionalParams	Optional parameters.
GraphQueryDeleteOptionalParams	Optional parameters.
GraphQueryError	Error message body that will indicate why the operation failed.
GraphQueryErrorError	The error object.
GraphQueryGetOptionalParams	Optional parameters.
GraphQueryListBySubscriptionOptionalParams	Optional parameters.
GraphQueryListOptionalParams	Optional parameters.
GraphQueryOperations	Interface representing a GraphQuery operations.
GraphQueryProperties	Properties that contain a graph query.
GraphQueryPropertiesUpdateParameters	Properties that contain a workbook for PATCH operation.
GraphQueryResource	Graph Query entity definition.
GraphQueryUpdateOptionalParams	Optional parameters.
GraphQueryUpdateParameters	The parameters that can be provided when updating workbook properties properties.
Operation	Resource Graph REST API operation definition.
OperationDisplay	Display metadata associated with the operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QueryRequest	Describes a query to be executed.
QueryRequestOptions	The options for query evaluation
QueryResponse	Query result.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceChangeData	Data on a specific change, represented by a pair of before and after resource snapshots.
ResourceChangeDataAfterSnapshot	The snapshot after the change.
ResourceChangeDataBeforeSnapshot	The snapshot before the change.
ResourceChangeDetailsOptionalParams	Optional parameters.
ResourceChangeDetailsRequestParameters	The parameters for a specific change details request.
ResourceChangeList	A list of changes associated with a resource over a specific time interval.
ResourceChangesOptionalParams	Optional parameters.
ResourceChangesRequestParameters	The parameters for a specific changes request.
ResourceChangesRequestParametersInterval	Specifies the date and time interval for a changes request.
ResourceGraphClientOptionalParams	Optional parameters for the client.
ResourcePropertyChange	The resource property change
ResourceSnapshotData	Data on a specific resource snapshot.
ResourcesHistoryOptionalParams	Optional parameters.
ResourcesHistoryRequest	Describes a history request to be executed.
ResourcesHistoryRequestOptions	The options for history request evaluation
ResourcesOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.

Type Aliases

AuthorizationScopeFilter	Defines what level of authorization resources should be returned based on the which subscriptions and management groups are passed as scopes.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ChangeCategory	The change category.
ChangeType	The change type for snapshot. PropertyChanges will be provided in case of Update change type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
FacetSortOrder	The sorting order by the selected column (count by default).
FacetUnion	Alias for FacetUnion
PropertyChangeType	The property change Type
ResourcesHistoryResponse
ResultFormat	Defines in which format query result returned.
ResultKind	Enum indicating a type of graph query. KnownResultKind can be used interchangeably with ResultKind, this enum contains the known values that the service supports. Known values supported by the service basic: basic
ResultTruncated	Indicates whether the query results are truncated.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownResultKind	Enum indicating a type of graph query.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor