scoping_configuration

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

Overview

Name	scoping_configuration
Type	Resource
Id	azure_extras.app_compliance_automation.scoping_configuration

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}. # pylint: disable=line-too-long
name	string	The name of the resource.
answers	array	List of scoping question answers.
provisioningState	string	Azure lifecycle management. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
answers	array	List of scoping question answers.
provisioningState	string	Azure lifecycle management. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
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	report_name, scoping_configuration_name		Get the AppComplianceAutomation scoping configuration of the specific report.
list	select	report_name		Returns a list format of the singleton scopingConfiguration for a specified report.
create_or_update	insert	report_name, scoping_configuration_name, properties		Get the AppComplianceAutomation scoping configuration of the specific report.
create_or_update	replace	report_name, scoping_configuration_name, properties		Get the AppComplianceAutomation scoping configuration of the specific report.
delete	delete	report_name, scoping_configuration_name		Clean the AppComplianceAutomation scoping configuration of the specific report.

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
report_name	string	Report Name. Required.
scoping_configuration_name	string	The scoping configuration of the specific report. Required.

SELECT examples

get

Get the AppComplianceAutomation scoping configuration of the specific report.

SELECT
id,
name,
answers,
provisioningState,
systemData,
type
FROM azure_extras.app_compliance_automation.scoping_configuration
WHERE report_name = '{{ report_name }}' -- required
AND scoping_configuration_name = '{{ scoping_configuration_name }}' -- required
;

list

Returns a list format of the singleton scopingConfiguration for a specified report.

SELECT
id,
name,
answers,
provisioningState,
systemData,
type
FROM azure_extras.app_compliance_automation.scoping_configuration
WHERE report_name = '{{ report_name }}' -- required
;

INSERT examples

create_or_update

Get the AppComplianceAutomation scoping configuration of the specific report.

INSERT INTO azure_extras.app_compliance_automation.scoping_configuration (
properties,
report_name,
scoping_configuration_name
)
SELECT 
'{{ properties }}' /* required */,
'{{ report_name }}',
'{{ scoping_configuration_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: scoping_configuration
props:
  - name: report_name
    value: "{{ report_name }}"
    description: Required parameter for the scoping_configuration resource.
  - name: scoping_configuration_name
    value: "{{ scoping_configuration_name }}"
    description: Required parameter for the scoping_configuration resource.
  - name: properties
    description: |
      ScopingConfiguration property. Required.
    value:
      answers:
        - questionId: "{{ questionId }}"
          answers: "{{ answers }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Get the AppComplianceAutomation scoping configuration of the specific report.

REPLACE azure_extras.app_compliance_automation.scoping_configuration
SET 
properties = '{{ properties }}'
WHERE 
report_name = '{{ report_name }}' --required
AND scoping_configuration_name = '{{ scoping_configuration_name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Clean the AppComplianceAutomation scoping configuration of the specific report.

DELETE FROM azure_extras.app_compliance_automation.scoping_configuration
WHERE report_name = '{{ report_name }}' --required
AND scoping_configuration_name = '{{ scoping_configuration_name }}' --required
;