Topology - List

Dienst:

Defender for Cloud

API-Version:

2015-06-01-preview

Ruft eine Liste ab, mit der eine Topologieansicht eines Abonnements erstellt werden kann.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/topologies?api-version=2015-06-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Azure-Abonnement-ID
api-version	query	True	string	API-Version für den Vorgang

Antworten

Name	Typ	Beschreibung
200 OK	TopologyList	OKAY
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get topology on a subscription

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/providers/Microsoft.Security/topologies?api-version=2015-06-01-preview

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "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": "Internal",
            "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"
    },
    {
      "properties": {
        "calculatedDateTime": "2018-07-10T13:56:10.5755270Z",
        "topologyResources": [
          {
            "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet",
            "severity": "Healthy",
            "networkZones": "Internal",
            "recommendationsExist": false,
            "topologyScore": 5,
            "location": "westus",
            "parents": [
              {
                "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet"
              }
            ]
          }
        ]
      },
      "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/subnets",
      "name": "subnets",
      "type": "Microsoft.Security/locations/topologies",
      "location": "westus"
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
CloudErrorBody	Das Fehlerdetails.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
TopologyList
TopologyResource
TopologySingleResource
TopologySingleResourceChild
TopologySingleResourceParent

CloudError

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error.additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
error.code	string	Der Fehlercode.
error.details	CloudErrorBody[]	Die Fehlerdetails.
error.message	string	Die Fehlermeldung.
error.target	string	Das Fehlerziel.

CloudErrorBody

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	CloudErrorBody[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

TopologyList

Objekt

Name	Typ	Beschreibung
nextLink	string	Der URI zum Abrufen der nächsten Seite.
value	TopologyResource[]

TopologyResource

Objekt

Name	Typ	Beschreibung
id	string	Ressourcen-ID
location	string	Speicherort der Ressource
name	string	Ressourcenname
properties.calculatedDateTime	string (date-time)	Die UTC-Zeit, zu der die Topologie berechnet wurde
properties.topologyResources	TopologySingleResource[]	Azure-Ressourcen, die Teil dieser Topologieressource sind
type	string	Ressourcentyp

TopologySingleResource

Objekt

Name	Typ	Beschreibung
children	TopologySingleResourceChild[]	Azure-Ressourcen, die mit dieser Ressource verbunden sind, die sich in der Topologieansicht auf niedrigerer Ebene befinden
location	string	Der Speicherort dieser Ressource
networkZones	string	Gibt die Ressourcenkonnektivitätsebene mit dem Internet an (InternetFacing, Intern usw.)
parents	TopologySingleResourceParent[]	Azure-Ressourcen, die mit dieser Ressource verbunden sind, die sich in der Topologieansicht auf höherer Ebene befinden
recommendationsExist	boolean	Gibt an, ob die Ressource Sicherheitsempfehlungen enthält.
resourceId	string	Azure-Ressourcen-ID
severity	string	Der Sicherheitsschweregrad der Ressource
topologyScore	integer	Bewertung der Ressource basierend auf dem Sicherheitsschweregrad

TopologySingleResourceChild

Objekt

Name	Typ	Beschreibung
resourceId	string	Azure-Ressourcen-ID, die als untergeordnete Ressource in der Topologieansicht dient

TopologySingleResourceParent

Objekt

Name	Typ	Beschreibung
resourceId	string	Azure-Ressourcen-ID, die als übergeordnete Ressource in der Topologieansicht dient