topologies

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

Overview

Name	topologies
Type	Resource
Id	azure.security.topologies

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
location	string	Location where the resource is stored
properties	object
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_home_region

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
location	string	Location where the resource is stored
properties	object
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
location	string	Location where the resource is stored
properties	object
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, ascLocation, topologyResourceName	api-version	Gets a specific topology component.
list_by_home_region	select	subscriptionId, ascLocation	api-version	Gets a list that allows to build a topology view of a subscription and location.
list	select	subscriptionId	api-version	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
ascLocation	string	The location where ASC stores the data of the subscription. can be retrieved from Get locations
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string	Azure subscription ID
topologyResourceName	string	Name of a topology resources collection.
api-version	string	API version for the operation

SELECT examples

get

Gets a specific topology component.

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

list_by_home_region

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

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

list

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

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