Topology - List

Referenz

Dienst:: Defender for Cloud

API-Version:: 2020-01-01

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=2020-01-01

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

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


/**
 * Samples for Topology List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/Topology/
     * GetTopologySubscription_example.json
     */
    /**
     * Sample code: Get topology on a subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getTopologyOnASubscription(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.topologies().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/Topology/GetTopologySubscription_example.json
func ExampleTopologyClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTopologyClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.TopologyList = armsecurity.TopologyList{
		// 	Value: []*armsecurity.TopologyResource{
		// 		{
		// 			Location: to.Ptr("westus"),
		// 			Name: to.Ptr("vnets"),
		// 			Type: to.Ptr("Microsoft.Security/locations/topologies"),
		// 			ID: to.Ptr("/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets"),
		// 			Properties: &armsecurity.TopologyResourceProperties{
		// 				CalculatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-07-10T13:56:10.575Z"); return t}()),
		// 				TopologyResources: []*armsecurity.TopologySingleResource{
		// 					{
		// 						Children: []*armsecurity.TopologySingleResourceChild{
		// 							{
		// 								ResourceID: to.Ptr("/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet"),
		// 						}},
		// 						Location: to.Ptr("westus"),
		// 						NetworkZones: to.Ptr("Internal"),
		// 						RecommendationsExist: to.Ptr(false),
		// 						ResourceID: to.Ptr("/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet"),
		// 						Severity: to.Ptr("Healthy"),
		// 						TopologyScore: to.Ptr[int32](0),
		// 				}},
		// 			},
		// 		},
		// 		{
		// 			Location: to.Ptr("westus"),
		// 			Name: to.Ptr("subnets"),
		// 			Type: to.Ptr("Microsoft.Security/locations/topologies"),
		// 			ID: to.Ptr("/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/subnets"),
		// 			Properties: &armsecurity.TopologyResourceProperties{
		// 				CalculatedDateTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-07-10T13:56:10.575Z"); return t}()),
		// 				TopologyResources: []*armsecurity.TopologySingleResource{
		// 					{
		// 						Location: to.Ptr("westus"),
		// 						NetworkZones: to.Ptr("Internal"),
		// 						Parents: []*armsecurity.TopologySingleResourceParent{
		// 							{
		// 								ResourceID: to.Ptr("/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet"),
		// 						}},
		// 						RecommendationsExist: to.Ptr(false),
		// 						ResourceID: to.Ptr("/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet"),
		// 						Severity: to.Ptr("Healthy"),
		// 						TopologyScore: to.Ptr[int32](5),
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list that allows to build a topology view of a subscription.
 *
 * @summary Gets a list that allows to build a topology view of a subscription.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/Topology/GetTopologySubscription_example.json
 */
async function getTopologyOnASubscription() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "3eeab341-f466-499c-a8be-85427e154bad";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.topology.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter.Models;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/Topology/GetTopologySubscription_example.json
// this example is just showing the usage of "Topology_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "3eeab341-f466-499c-a8be-85427e154bad";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (SecurityTopologyResource item in subscriptionResource.GetTopologiesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Freigeben über

Topology - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Get topology on a subscription

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorBody

ErrorAdditionalInfo

TopologyList

TopologyResource

TopologySingleResource

TopologySingleResourceChild

TopologySingleResourceParent