custom_assessment_automations

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

Overview

Name	custom_assessment_automations
Type	Resource
Id	azure.security.custom_assessment_automations

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 Assessment Automation 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_by_resource_group

OK - Returns a collection of Custom Assessment Automations

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 Assessment Automation 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_by_subscription

OK - Returns a collection of Custom Assessment Automations

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 Assessment Automation 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	subscriptionId, resourceGroupName, customAssessmentAutomationName	api-version	Gets a single custom assessment automation by name for the provided subscription and resource group.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	List custom assessment automations by provided subscription and resource group
list_by_subscription	select	subscriptionId	api-version	List custom assessment automations by provided subscription
create	insert	subscriptionId, resourceGroupName, customAssessmentAutomationName	api-version	Creates or updates a custom assessment automation for the provided subscription. Please note that providing an existing custom assessment automation will replace the existing record.
delete	delete	subscriptionId, resourceGroupName, customAssessmentAutomationName	api-version	Deletes a custom assessment automation by name for a provided 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
customAssessmentAutomationName	string	Name of the Custom Assessment Automation.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Gets a single custom assessment automation by name for the provided subscription and resource group.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_assessment_automations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND customAssessmentAutomationName = '{{ customAssessmentAutomationName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

List custom assessment automations by provided subscription and resource group

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_assessment_automations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_subscription

List custom assessment automations by provided subscription

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_assessment_automations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates or updates a custom assessment automation for the provided subscription. Please note that providing an existing custom assessment automation will replace the existing record.

INSERT INTO azure.security.custom_assessment_automations (
data__properties,
subscriptionId,
resourceGroupName,
customAssessmentAutomationName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ customAssessmentAutomationName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: custom_assessment_automations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the custom_assessment_automations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_assessment_automations resource.
    - name: customAssessmentAutomationName
      value: string
      description: Required parameter for the custom_assessment_automations resource.
    - name: properties
      value: object
      description: |
        describes Custom Assessment Automation request properties.
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete

Deletes a custom assessment automation by name for a provided subscription

DELETE FROM azure.security.custom_assessment_automations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND customAssessmentAutomationName = '{{ customAssessmentAutomationName }}' --required
AND api-version = '{{ api-version }}'
;