Share via

ResourceGraphClient class

  • Reference
Package:
@azure/arm-resourcegraph
Extends
ServiceClient

Constructors

ResourceGraphClient(TokenCredential, ResourceGraphClientOptionalParams)

Initializes a new instance of the ResourceGraphClient class.

Properties

$host
apiVersion
operations

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

resources(QueryRequest, ResourcesOptionalParams)

Queries the resources managed by Azure Resource Manager for scopes specified in the request.
resourcesHistory(ResourcesHistoryRequest, ResourcesHistoryOptionalParams)

List all snapshots of a resource for a given time interval.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

ResourceGraphClient(TokenCredential, ResourceGraphClientOptionalParams)

Initializes a new instance of the ResourceGraphClient class.

new ResourceGraphClient(credentials: TokenCredential, options?: ResourceGraphClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

options
ResourceGraphClientOptionalParams

The parameter options

Property Details

$host 

$host: string

Property Value

string

apiVersion 

apiVersion: string

Property Value

string

operations 

operations: Operations

Property Value

Operations

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

resources(QueryRequest, ResourcesOptionalParams)

Queries the resources managed by Azure Resource Manager for scopes specified in the request.

function resources(query: QueryRequest, options?: ResourcesOptionalParams): Promise<QueryResponse>

Parameters

query
QueryRequest

Request specifying query and its options.

options
ResourcesOptionalParams

The options parameters.

Returns

Promise<QueryResponse>

resourcesHistory(ResourcesHistoryRequest, ResourcesHistoryOptionalParams)

List all snapshots of a resource for a given time interval.

function resourcesHistory(request: ResourcesHistoryRequest, options?: ResourcesHistoryOptionalParams): Promise<ResourcesHistoryResponse>

Parameters

request
ResourcesHistoryRequest

Request specifying the query and its options.

options
ResourcesHistoryOptionalParams

The options parameters.

Returns

Promise<ResourcesHistoryResponse>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest