Analysis: Azure Systems

Analysis: Azure Systems

#340650

Description

The /analysis/cloud/azure/<analysisId>/systems resource is used to return a collection of all the systems (Virtual Machines) that were included in the Azure optimization analysis.

The recommendations from an Azure optimization analysis can be obtained using the /analysis/cloud/azure/<analysisId>/results resource. See Analysis: Azure Recommendations for details on the Azure recommendations resource. The set of analyzed systems in an analysis may be more than the set of recommendations produced, as there can be no recommendations for some analyzed systems.

Resource

/analysis/cloud/azure/<analysisId>/systems

Supported Operations

Table: Azure Systems Supported Operations

Operation

HTTP Method

Input

Output

Description

List all systems included in an Azure analysis

GET /analysis/cloud/azure/<analysisId>/systems

Path Parameter:

Collection of:

Use this resource to return a list of all systems included in the Azure analysis.

Example: Listing All Systems in an Azure Analysis

Parameters

Path Parameters

Table: Azure System Path Parameters

Parameter Name

Type

Description

analysisId

string

The unique referenced ID of the Azure analysis.

Response

Table: Azure System Response Schema

Element

Type

Filter/Sort

Description

serviceType

string

 

The cloud service type (i.e. Virtual Machine).

resourceId

string

 

The Azure unique identifier assigned to the instance (Virtual Machine).

powerState

string

 

The power state of the instance.

currentType

string

 

The current instance type of the Azure instance.

displayName

string

 

The name assigned to the instance. For Azure Virtual Machines, the displayName is the same as the unique identifier in resourceId.

entityId

string

 

The Densify assigned entity ID of the Azure system.

href

string

 

The referenced resource to the system entity.

See Systems for details of the /systems resource.

Examples

Example: Listing All Systems in an Azure Analysis

The following example shows you how to return all systems (Virtual Machine instances) included in an Azure optimization analysis.

Request:

Copy 
GET /analysis/cloud/azure/8b8ab8e1-a026-4db9-a4ae-2d6878467e8f/systems

Response:

Copy 
[
   {
      "serviceType": "Virtual Machine",
      "resourceId": "st02-db-edge-695",
      "powerState": "Running",
      "currentType": "standard_a2_v2",
      "displayName": "st02-db-edge-695",
      "entityId": "0137f635-eacd-44da-878f-a4482166f9c1",
      "href": "/systems/0137f635-eacd-44da-878f-a4482166f9c1"
   },
   {
      "serviceType": "Virtual Machine",
      "resourceId": "st01-io-asop-216",
      "powerState": "Running",
      "currentType": "standard_d1_v2",
      "displayName": "st01-io-asop-216",
      "entityId": "065c44d5-040a-4392-9d08-5f581bedb401",
      "href": "/systems/065c44d5-040a-4392-9d08-5f581bedb401"
   },
   ...
]