Topology - Get

Gets a specific topology component.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/topologies/{topologyResourceName}?api-version=2020-01-01

URI Parameters

Name In Required Type Description
ascLocation
path True

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

resourceGroupName
path True

string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

topologyResourceName
path True

string

Name of a topology resources collection.

api-version
query True

string

API version for the operation

Responses

Name Type Description
200 OK

TopologyResource

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get topology

Sample request

GET https://management.azure.com/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets?api-version=2020-01-01

Sample response

{
  "properties": {
    "calculatedDateTime": "2018-07-10T13:56:10.5755270Z",
    "topologyResources": [
      {
        "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet",
        "severity": "Healthy",
        "networkZones": "InternetFacing",
        "recommendationsExist": false,
        "topologyScore": 0,
        "location": "westus",
        "children": [
          {
            "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet"
          }
        ]
      }
    ]
  },
  "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets",
  "name": "vnets",
  "type": "Microsoft.Security/locations/topologies",
  "location": "westus"
}

Definitions

Name Description
CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

CloudErrorBody

The error detail.

ErrorAdditionalInfo

The resource management error additional info.

TopologyResource
TopologySingleResource
TopologySingleResourceChild
TopologySingleResourceParent

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name Type Description
error.additionalInfo

ErrorAdditionalInfo[]

The error additional info.

error.code

string

The error code.

error.details

CloudErrorBody[]

The error details.

error.message

string

The error message.

error.target

string

The error target.

CloudErrorBody

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

CloudErrorBody[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

TopologyResource

Name Type Description
id

string

Resource Id

location

string

Location where the resource is stored

name

string

Resource name

properties.calculatedDateTime

string

The UTC time on which the topology was calculated

properties.topologyResources

TopologySingleResource[]

Azure resources which are part of this topology resource

type

string

Resource type

TopologySingleResource

Name Type Description
children

TopologySingleResourceChild[]

Azure resources connected to this resource which are in lower level in the topology view

location

string

The location of this resource

networkZones

string

Indicates the resource connectivity level to the Internet (InternetFacing, Internal ,etc.)

parents

TopologySingleResourceParent[]

Azure resources connected to this resource which are in higher level in the topology view

recommendationsExist

boolean

Indicates if the resource has security recommendations

resourceId

string

Azure resource id

severity

string

The security severity of the resource

topologyScore

integer

Score of the resource based on its security severity

TopologySingleResourceChild

Name Type Description
resourceId

string

Azure resource id which serves as child resource in topology view

TopologySingleResourceParent

Name Type Description
resourceId

string

Azure resource id which serves as parent resource in topology view