discovery_groups

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

Overview

Name	discovery_groups
Type	Resource
Id	azure.defender_easm_dataplane.discovery_groups

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete	delete	group_name, subscription_id, resource_group_name, workspace_name, endpoint		Delete a discovery group with a given groupName. Delete a discovery group with a given groupName.
get_raw	exec	group_name, subscription_id, resource_group_name, workspace_name, endpoint		Retrieve a discovery group with a given groupName. Retrieve a discovery group with a given groupName.
put	exec	group_name, subscription_id, resource_group_name, workspace_name, endpoint		Create a discovery group with a given groupName. Create a discovery group with a given groupName.
list_raw	exec	subscription_id, resource_group_name, workspace_name, endpoint	filter, skip	Retrieve a list of discovery group for the provided search parameters. Retrieve a list of discovery group for the provided search parameters.
list_runs	exec	group_name, subscription_id, resource_group_name, workspace_name, endpoint	filter, skip	Retrieve a collection of discovery run results for a discovery group with a given groupName. Retrieve a collection of discovery run results for a discovery group with a given groupName.
run	exec	group_name, subscription_id, resource_group_name, workspace_name, endpoint		Run a discovery group with a given groupName. Run a discovery group with a given groupName.
validate	exec	group_name, subscription_id, resource_group_name, workspace_name, endpoint		Validate a discovery group with a given groupName. Validate a discovery group with a given groupName.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
group_name	string	The unique identifier for the discovery group. Required.
resource_group_name	string
subscription_id	string
workspace_name	string
filter	string	An expression on the resource type that selects the resources to be returned. Default value is None.
skip	integer	An offset into the collection of the first item to be returned. Default value is 0.

DELETE examples

delete

Delete a discovery group with a given groupName. Delete a discovery group with a given groupName.

DELETE FROM azure.defender_easm_dataplane.discovery_groups
WHERE group_name = '{{ group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Retrieve a discovery group with a given groupName. Retrieve a discovery group with a given groupName.

EXEC azure.defender_easm_dataplane.discovery_groups.get_raw 
@group_name='{{ group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

put

Create a discovery group with a given groupName. Create a discovery group with a given groupName.

EXEC azure.defender_easm_dataplane.discovery_groups.put 
@group_name='{{ group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_raw

Retrieve a list of discovery group for the provided search parameters. Retrieve a list of discovery group for the provided search parameters.

EXEC azure.defender_easm_dataplane.discovery_groups.list_raw 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@skip='{{ skip }}'
;

list_runs

Retrieve a collection of discovery run results for a discovery group with a given groupName. Retrieve a collection of discovery run results for a discovery group with a given groupName.

EXEC azure.defender_easm_dataplane.discovery_groups.list_runs 
@group_name='{{ group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@skip='{{ skip }}'
;

run

Run a discovery group with a given groupName. Run a discovery group with a given groupName.

EXEC azure.defender_easm_dataplane.discovery_groups.run 
@group_name='{{ group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;

validate

Validate a discovery group with a given groupName. Validate a discovery group with a given groupName.

EXEC azure.defender_easm_dataplane.discovery_groups.validate 
@group_name='{{ group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;