@datafire/azure_resourcegraph_graphquery

Client library for Azure Resource Graph Query

Installation and Usage

``bash
npm install --save @datafire/azure_resourcegraph_graphquery
`
`js
let azure_resourcegraph_graphquery = require('@datafire/azure_resourcegraph_graphquery').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});

.then(data => {
console.log(data);
});
`

Description

Azure Resource Graph Query API Reference

Actions

$3

Get all graph queries defined within a specified subscription and resource group.


`js
azure_resourcegraph_graphquery.GraphQuery_List({
"subscriptionId": "",
"resourceGroupName": "",
"api-version": ""
}, context)
`

#### Input
* input object
* subscriptionId required string: The Azure subscription Id.
* resourceGroupName required string: The name of the resource group.
* api-version required string: Client Api Version.

#### Output
* output GraphQueryListResult

$3

Delete a graph query.


`js
azure_resourcegraph_graphquery.GraphQuery_Delete({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
`

#### Input
* input object
* subscriptionId required string: The Azure subscription Id.
* resourceGroupName required string: The name of the resource group.
* resourceName required string: The name of the Graph Query resource.
* api-version required string: Client Api Version.

#### Output
Output schema unknown

$3

Get a single graph query by its resourceName.


`js
azure_resourcegraph_graphquery.GraphQuery_Get({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": ""
}, context)
`

#### Input
* input object
* subscriptionId required string: The Azure subscription Id.
* resourceGroupName required string: The name of the resource group.
* resourceName required string: The name of the Graph Query resource.
* api-version required string: Client Api Version.

#### Output
* output GraphQueryResource

$3

Updates a graph query that has already been added.


`js
azure_resourcegraph_graphquery.GraphQuery_Update({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": "",
"body": null
}, context)
`

#### Input
* input object
* subscriptionId required string: The Azure subscription Id.
* resourceGroupName required string: The name of the resource group.
* resourceName required string: The name of the Graph Query resource.
* api-version required string: Client Api Version.
* body required GraphQueryUpdateParameters

#### Output
* output GraphQueryResource

$3

Create a new graph query.


`js
azure_resourcegraph_graphquery.GraphQuery_CreateOrUpdate({
"subscriptionId": "",
"resourceGroupName": "",
"resourceName": "",
"api-version": "",
"properties": null
}, context)
`

#### Input
* input object
* subscriptionId required string: The Azure subscription Id.
* resourceGroupName required string: The name of the resource group.
* resourceName required string: The name of the Graph Query resource.
* api-version required string: Client Api Version.
* properties required GraphQueryResource

#### Output
* output GraphQueryResource

Definitions

$3


* ErrorFieldContract object: Error Field contract.
* code string: Property level error code.
* message string: Human-readable representation of property-level error.
* target string: Property name.

$3

* GraphQueryError object: Error message body that will indicate why the operation failed.
* code string: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
* details array: The list of invalid fields send in request, in case of validation error.
* items ErrorFieldContract
* message string: Human-readable representation of the error.

$3

* GraphQueryListResult object: Graph query list result.
* nextLink string: URL to fetch the next set of queries.
* value array: An array of graph queries.
* items GraphQueryResource

$3

* GraphQueryProperties object: Properties that contain a graph query.
* description string: The description of a graph query.
* query required string: KQL query that will be graph.
* resultKind string (values: basic): Enum indicating a type of graph query.
* timeModified string: Date and time in UTC of the last modification that was made to this graph query definition.

$3

* GraphQueryPropertiesUpdateParameters object: Properties that contain a workbook for PATCH operation.
* description string: The description of a graph query.
* query string: KQL query that will be graph.

$3

* GraphQueryResource object: Graph Query entity definition.
* properties GraphQueryProperties
* eTag string: This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict.
* id string: Azure resource Id
* name string: Azure resource name. This is GUID value. The display name should be assigned within properties field.
* tags object: Resource tags
* type string: Azure resource type

$3

* GraphQueryUpdateParameters object: The parameters that can be provided when updating workbook properties properties.
* eTag string: This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict.
* properties GraphQueryPropertiesUpdateParameters
* tags object: Resource tags

$3

* Resource object: An azure resource object
* eTag string: This will be used to handle Optimistic Concurrency. If not present, it will always overwrite the existing resource without checking conflict.
* id string: Azure resource Id
* name string: Azure resource name. This is GUID value. The display name should be assigned within properties field.
* tags object: Resource tags
* type string`: Azure resource type