Topology - List

Usługa:

Defender for Cloud

Wersja interfejsu API:

2015-06-01-preview

Pobiera listę, która umożliwia utworzenie widoku topologii subskrypcji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Identyfikator subskrypcji platformy Azure
api-version	query	True	string	Wersja interfejsu API dla operacji

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TopologyList	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get topology on a subscription

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
CloudError	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
CloudErrorBody	Szczegóły błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
TopologyList
TopologyResource
TopologySingleResource
TopologySingleResourceChild
TopologySingleResourceParent

CloudError

Objekt

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

TopologyList

Objekt

Nazwa	Typ	Opis
nextLink	string	Identyfikator URI do pobrania następnej strony.
value	TopologyResource[]

TopologyResource

Objekt

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
location	string	Lokalizacja, w której jest przechowywany zasób
name	string	Nazwa zasobu
properties.calculatedDateTime	string (date-time)	Czas UTC, o którym obliczano topologię
properties.topologyResources	TopologySingleResource[]	Zasoby platformy Azure będące częścią tego zasobu topologii
type	string	Typ zasobu

TopologySingleResource

Objekt

Nazwa	Typ	Opis
children	TopologySingleResourceChild[]	Zasoby platformy Azure połączone z tym zasobem, które znajdują się na niższym poziomie w widoku topologii
location	string	Lokalizacja tego zasobu
networkZones	string	Wskazuje poziom łączności zasobów z Internetem (InternetFacing, Wewnętrzny itp.)
parents	TopologySingleResourceParent[]	Zasoby platformy Azure połączone z tym zasobem, które znajdują się na wyższym poziomie w widoku topologii
recommendationsExist	boolean	Wskazuje, czy zasób ma zalecenia dotyczące zabezpieczeń
resourceId	string	Identyfikator zasobu platformy Azure
severity	string	Ważność zabezpieczeń zasobu
topologyScore	integer	Ocena zasobu na podstawie ważności zabezpieczeń

TopologySingleResourceChild

Objekt

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu platformy Azure, który służy jako zasób podrzędny w widoku topologii

TopologySingleResourceParent

Objekt

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu platformy Azure, który służy jako zasób nadrzędny w widoku topologii