topology

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

Overview

Name	topology
Type	Resource
Id	azure.security.topology

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.
calculatedDateTime	string (date-time)	The UTC time on which the topology was calculated.
location	string	Location where the resource is stored. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topologyResources	array	Azure resources which are part of this topology resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_home_region

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.
calculatedDateTime	string (date-time)	The UTC time on which the topology was calculated.
location	string	Location where the resource is stored. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topologyResources	array	Azure resources which are part of this topology resource.
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}.
name	string	The name of the resource.
calculatedDateTime	string (date-time)	The UTC time on which the topology was calculated.
location	string	Location where the resource is stored. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topologyResources	array	Azure resources which are part of this topology resource.
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	resource_group_name, asc_location, topology_resource_name, subscription_id		Gets a specific topology component.
list_by_home_region	select	asc_location, subscription_id		Gets a list that allows to build a topology view of a subscription and location.
list	select	subscription_id		Gets a list that allows to build a topology view of a 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
asc_location	string	The location where ASC stores the data of the subscription. can be retrieved from Get locations. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
topology_resource_name	string	Name of a topology resources collection. Required.

SELECT examples

get

Gets a specific topology component.

SELECT
id,
name,
calculatedDateTime,
location,
systemData,
topologyResources,
type
FROM azure.security.topology
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND asc_location = '{{ asc_location }}' -- required
AND topology_resource_name = '{{ topology_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_home_region

Gets a list that allows to build a topology view of a subscription and location.

SELECT
id,
name,
calculatedDateTime,
location,
systemData,
topologyResources,
type
FROM azure.security.topology
WHERE asc_location = '{{ asc_location }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list that allows to build a topology view of a subscription.

SELECT
id,
name,
calculatedDateTime,
location,
systemData,
topologyResources,
type
FROM azure.security.topology
WHERE subscription_id = '{{ subscription_id }}' -- required
;