impact_categories

Creates, updates, deletes, gets or lists an impact_categories resource.

Overview

Name	impact_categories
Type	Resource
Id	azure.impact_reporting.impact_categories

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
categoryId	string	Unique ID of the category. Required.
description	string	Description of the category.
parentCategoryId	string	Unique ID of the parent category.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
requiredImpactProperties	array	The workloadImpact properties which are required when reporting with the impact category.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
categoryId	string	Unique ID of the category. Required.
description	string	Description of the category.
parentCategoryId	string	Unique ID of the parent category.
provisioningState	string	Resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
requiredImpactProperties	array	The workloadImpact properties which are required when reporting with the impact category.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	impact_category_name, subscription_id		Get a ImpactCategory.
list_by_subscription	select	subscription_id, resourceType	categoryName	List ImpactCategory resources by subscription.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
impact_category_name	string	Name of the impact category. Required.
resourceType	string	Filter by resource type. Required.
subscription_id	string
categoryName	string	Filter by category name. Default value is None.

SELECT examples

get

Get a ImpactCategory.

SELECT
id,
name,
categoryId,
description,
parentCategoryId,
provisioningState,
requiredImpactProperties,
systemData,
type
FROM azure.impact_reporting.impact_categories
WHERE impact_category_name = '{{ impact_category_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List ImpactCategory resources by subscription.

SELECT
id,
name,
categoryId,
description,
parentCategoryId,
provisioningState,
requiredImpactProperties,
systemData,
type
FROM azure.impact_reporting.impact_categories
WHERE subscription_id = '{{ subscription_id }}' -- required
AND resourceType = '{{ resourceType }}' -- required
AND categoryName = '{{ categoryName }}'
;