你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Topology - Get

参考

服务:: Defender for Cloud

API 版本:: 2020-01-01

获取特定的拓扑组件。

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

URI 参数

名称	在	必需	类型	说明
ascLocation	path	True	string	ASC 存储订阅数据的位置。可从获取位置检索
resourceGroupName	path	True	string	用户订阅中资源组的名称。此名称不区分大小写。正则表达式模式: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure 订阅 ID 正则表达式模式: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
topologyResourceName	path	True	string	拓扑资源集合的名称。
api-version	query	True	string	操作的 API 版本

响应

名称	类型	说明
200 OK	TopologyResource	确定
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get topology

示例请求

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


/**
 * Samples for Topology Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/Topology/
     * GetTopology_example.json
     */
    /**
     * Sample code: Get topology.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getTopology(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.topologies().getWithResponse("myservers", "centralus", "vnets", 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/GetTopology_example.json
func ExampleTopologyClient_Get() {
	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)
	}
	res, err := clientFactory.NewTopologyClient().Get(ctx, "myservers", "centralus", "vnets", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.TopologyResource = 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("InternetFacing"),
	// 				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),
	// 		}},
	// 	},
	// }
}

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 specific topology component.
 *
 * @summary Gets a specific topology component.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/Topology/GetTopology_example.json
 */
async function getTopology() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "3eeab341-f466-499c-a8be-85427e154bad";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "myservers";
  const ascLocation = "centralus";
  const topologyResourceName = "vnets";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.topology.get(resourceGroupName, ascLocation, topologyResourceName);
  console.log(result);
}

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/GetTopology_example.json
// this example is just showing the usage of "Topology_Get" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "3eeab341-f466-499c-a8be-85427e154bad";
string resourceGroupName = "myservers";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// invoke the operation
AzureLocation ascLocation = new AzureLocation("centralus");
string topologyResourceName = "vnets";
SecurityTopologyResource result = await resourceGroupResource.GetTopologyAsync(ascLocation, topologyResourceName);

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:: 200

{
  "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"
}

定义

名称	说明
CloudError	对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。
CloudErrorBody	错误详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
TopologyResource
TopologySingleResource
TopologySingleResourceChild
TopologySingleResourceParent

CloudError

对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

名称	类型	说明
error.additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
error.code	string	错误代码。
error.details	CloudErrorBody[]	错误详细信息。
error.message	string	错误消息。
error.target	string	错误目标。

CloudErrorBody

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	CloudErrorBody[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

TopologyResource

名称	类型	说明
id	string	资源 ID
location	string	存储资源的位置
name	string	资源名称
properties.calculatedDateTime	string	计算拓扑的 UTC 时间
properties.topologyResources	TopologySingleResource[]	属于此拓扑资源的 Azure 资源
type	string	资源类型

TopologySingleResource

名称	类型	说明
children	TopologySingleResourceChild[]	连接到拓扑视图中处于较低级别的此资源的 Azure 资源
location	string	此资源的位置
networkZones	string	指示与 Internet (InternetFacing、Internal 等的资源连接级别 )
parents	TopologySingleResourceParent[]	连接到此资源的 Azure 资源在拓扑视图中处于较高级别
recommendationsExist	boolean	指示资源是否具有安全建议
resourceId	string	Azure 资源 ID
severity	string	资源的安全严重性
topologyScore	integer	基于资源安全严重性的分数

TopologySingleResourceChild

名称	类型	说明
resourceId	string	在拓扑视图中用作子资源的 Azure 资源 ID

TopologySingleResourceParent

名称	类型	说明
resourceId	string	在拓扑视图中用作父资源的 Azure 资源 ID

通过

Topology - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Get topology

示例请求

示例响应

定义

CloudError

CloudErrorBody

ErrorAdditionalInfo

TopologyResource

TopologySingleResource

TopologySingleResourceChild

TopologySingleResourceParent

其他资源