Topology - Get

Referens

Service:: Defender for Cloud

API Version:: 2020-01-01

Hämtar en specifik topologikomponent.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
ascLocation	path	True	string	Platsen där ASC lagrar prenumerationens data. kan hämtas från Hämta platser
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure-prenumerations-ID Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
topologyResourceName	path	True	string	Namnet på en topologiresurssamling.
api-version	query	True	string	API-version för åtgärden

Svar

Name	Typ	Description
200 OK	TopologyResource	OK
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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


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

Sample Response

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

Definitioner

Name	Description
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
TopologyResource
TopologySingleResource
TopologySingleResourceChild
TopologySingleResourceParent

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

TopologyResource

Name	Typ	Description
id	string	Resurs-ID
location	string	Plats där resursen lagras
name	string	Resursnamn
properties.calculatedDateTime	string	UTC-tiden då topologin beräknades
properties.topologyResources	TopologySingleResource[]	Azure-resurser som ingår i den här topologiresursen
type	string	Resurstyp

TopologySingleResource

Name	Typ	Description
children	TopologySingleResourceChild[]	Azure-resurser som är anslutna till den här resursen på lägre nivå i topologivyn
location	string	Platsen för den här resursen
networkZones	string	Anger resursanslutningsnivån till Internet (InternetFacing, Intern osv.)
parents	TopologySingleResourceParent[]	Azure-resurser som är anslutna till den här resursen på högre nivå i topologivyn
recommendationsExist	boolean	Anger om resursen har säkerhetsrekommendationer
resourceId	string	Resurs-ID för Azure
severity	string	Resursens allvarlighetsgrad
topologyScore	integer	Poäng för resursen baserat på dess allvarlighetsgrad för säkerhet

TopologySingleResourceChild

Name	Typ	Description
resourceId	string	Azure-resurs-ID som fungerar som underordnad resurs i topologivyn

TopologySingleResourceParent

Name	Typ	Description
resourceId	string	Azure-resurs-ID som fungerar som överordnad resurs i topologivyn

Dela via

Topology - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

Get topology

Sample Request

Sample Response

Definitioner

CloudError

CloudErrorBody

ErrorAdditionalInfo

TopologyResource

TopologySingleResource

TopologySingleResourceChild

TopologySingleResourceParent

Ytterligare resurser