Topology - List

Başvuru

Service:: Defender for Cloud

API Version:: 2020-01-01

Aboneliğin topoloji görünümünü oluşturmaya olanak tanıyan bir liste alır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Azure abonelik kimliği Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	İşlem için API sürümü

subscriptionId

path

True

string

Azure abonelik kimliği

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

api-version

query

True

string

İşlem için API sürümü

Yanıtlar

Name	Tür	Description
200 OK	TopologyList	Tamam
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

Get topology on a subscription

Sample Request

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 System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// 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

Sample Response

Status code:: 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"
    }
  ]
}

Tanımlar

Name	Description
CloudError	Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.).
CloudErrorBody	Hata ayrıntısı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
TopologyList
TopologyResource
TopologySingleResource
TopologySingleResourceChild
TopologySingleResourceParent

CloudError

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıtı biçimini de izler.).

Name	Tür	Description
error.additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
error.code	string	Hata kodu.
error.details	CloudErrorBody[]	Hata ayrıntıları.
error.message	string	Hata iletisi.
error.target	string	Hata hedefi.

CloudErrorBody

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	CloudErrorBody[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

TopologyList

Name	Tür	Description
nextLink	string	Sonraki sayfayı getirmek için URI.
value	TopologyResource[]

TopologyResource

Name	Tür	Description
id	string	Kaynak Kimliği
location	string	Kaynağın depolandığı konum
name	string	Kaynak adı
properties.calculatedDateTime	string	Topolojinin hesaplandığı UTC saati
properties.topologyResources	TopologySingleResource[]	Bu topoloji kaynağının parçası olan Azure kaynakları
type	string	Kaynak türü

TopologySingleResource

Name	Tür	Description
children	TopologySingleResourceChild[]	Topoloji görünümünde daha düşük düzeyde olan bu kaynağa bağlı Azure kaynakları
location	string	Bu kaynağın konumu
networkZones	string	İnternet'e kaynak bağlantı düzeyini gösterir (InternetFacing, İç vb.)
parents	TopologySingleResourceParent[]	Topoloji görünümünde daha yüksek düzeyde olan bu kaynağa bağlı Azure kaynakları
recommendationsExist	boolean	Kaynağın güvenlik önerileri olup olmadığını gösterir
resourceId	string	Azure kaynak kimliği
severity	string	Kaynağın güvenlik önem derecesi
topologyScore	integer	Kaynağın güvenlik önem derecesine göre puanı

TopologySingleResourceChild

Name	Tür	Description
resourceId	string	Topoloji görünümünde alt kaynak görevi gören Azure kaynak kimliği

TopologySingleResourceParent

Name	Tür	Description
resourceId	string	Topoloji görünümünde üst kaynak görevi gören Azure kaynak kimliği

Aracılığıyla paylaş

Topology - List

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

Get topology on a subscription

Sample Request

Sample Response

Tanımlar

CloudError

CloudErrorBody

ErrorAdditionalInfo

TopologyList

TopologyResource

TopologySingleResource

TopologySingleResourceChild

TopologySingleResourceParent

Ek kaynaklar