custom_recommendations

Creates, updates, deletes, gets or lists a custom_recommendations resource.

Overview

Name	custom_recommendations
Type	Resource
Id	azure.security.custom_recommendations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes Custom Recommendation properties.
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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes Custom Recommendation properties.
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	scope, customRecommendationName		Get a specific custom recommendation for the requested scope by customRecommendationName
list	select	scope		Get a list of all relevant custom recommendations over a scope
create_or_update	insert	scope, customRecommendationName		Creates or updates a custom recommendation over a given scope
delete	delete	scope, customRecommendationName		Delete a custom recommendation over a given scope

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
customRecommendationName	string	Name of the Custom Recommendation.
scope	string	The scope of the standard assignment. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

SELECT examples

get

Get a specific custom recommendation for the requested scope by customRecommendationName

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_recommendations
WHERE scope = '{{ scope }}' -- required
AND customRecommendationName = '{{ customRecommendationName }}' -- required
;

list

Get a list of all relevant custom recommendations over a scope

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_recommendations
WHERE scope = '{{ scope }}' -- required
;

INSERT examples

create_or_update

Creates or updates a custom recommendation over a given scope

INSERT INTO azure.security.custom_recommendations (
data__properties,
scope,
customRecommendationName
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ customRecommendationName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: custom_recommendations
  props:
    - name: scope
      value: string
      description: Required parameter for the custom_recommendations resource.
    - name: customRecommendationName
      value: string
      description: Required parameter for the custom_recommendations resource.
    - name: properties
      value: object
      description: |
        describes Custom Recommendation properties.

DELETE examples

delete

Delete a custom recommendation over a given scope

DELETE FROM azure.security.custom_recommendations
WHERE scope = '{{ scope }}' --required
AND customRecommendationName = '{{ customRecommendationName }}' --required
;