Software Inventories - Get

Reference

Service:: Defender for Cloud

API Version:: 2021-05-01-preview

Gets a single software data of the virtual machine.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/softwareInventories/{softwareName}?api-version=2021-05-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: `^[-\w\._]+$`
resourceName	path	True	string	Name of the resource.
resourceNamespace	path	True	string	The namespace of the resource.
resourceType	path	True	string	The type of the resource.
softwareName	path	True	string	Name of the installed software.
subscriptionId	path	True	string	Azure subscription ID Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API version for the operation

Responses

Name	Type	Description
200 OK	Software	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

Gets a single software data of the virtual machine

Sample request

GET https://management.azure.com/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourceGroups/EITAN-TESTS/providers/Microsoft.Compute/virtualMachines/Eitan-Test1/providers/Microsoft.Security/softwareInventories/outlook_16.0.10371.20060?api-version=2021-05-01-preview


/**
 * Samples for SoftwareInventories Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2021-05-01-preview/examples/
     * SoftwareInventories/GetSoftware_example.json
     */
    /**
     * Sample code: Gets a single software data of the virtual machine.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        getsASingleSoftwareDataOfTheVirtualMachine(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.softwareInventories().getWithResponse("EITAN-TESTS", "Microsoft.Compute", "virtualMachines",
            "Eitan-Test1", "outlook_16.0.10371.20060", 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/preview/2021-05-01-preview/examples/SoftwareInventories/GetSoftware_example.json
func ExampleSoftwareInventoriesClient_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.NewSoftwareInventoriesClient().Get(ctx, "EITAN-TESTS", "Microsoft.Compute", "virtualMachines", "Eitan-Test1", "outlook_16.0.10371.20060", 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.Software = armsecurity.Software{
	// 	Name: to.Ptr("outlook_16.0.10371.20060"),
	// 	Type: to.Ptr("Microsoft.Security/softwareInventories"),
	// 	ID: to.Ptr("/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/EITAN-TESTS/providers/Microsoft.Compute/virtualMachines/Eitan-Test1/providers/Microsoft.Security/softwareInventories/outlook_16.0.10371.20060"),
	// 	Properties: &armsecurity.SoftwareProperties{
	// 		DeviceID: to.Ptr("7bd19ed6b07553e52a2844451bcec68d25963a53"),
	// 		EndOfSupportStatus: to.Ptr(armsecurity.EndOfSupportStatusNone),
	// 		FirstSeenAt: to.Ptr("2021-01-26 15:48:56"),
	// 		NumberOfKnownVulnerabilities: to.Ptr[int32](0),
	// 		OSPlatform: to.Ptr("Windows10"),
	// 		SoftwareName: to.Ptr("outlook"),
	// 		Vendor: to.Ptr("microsoft"),
	// 		Version: to.Ptr("16.0.10371.20060"),
	// 	},
	// }
}

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 single software data of the virtual machine.
 *
 * @summary Gets a single software data of the virtual machine.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2021-05-01-preview/examples/SoftwareInventories/GetSoftware_example.json
 */
async function getsASingleSoftwareDataOfTheVirtualMachine() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "e5d1b86c-3051-44d5-8802-aa65d45a279b";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "EITAN-TESTS";
  const resourceNamespace = "Microsoft.Compute";
  const resourceType = "virtualMachines";
  const resourceName = "Eitan-Test1";
  const softwareName = "outlook_16.0.10371.20060";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.softwareInventories.get(
    resourceGroupName,
    resourceNamespace,
    resourceType,
    resourceName,
    softwareName,
  );
  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;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2021-05-01-preview/examples/SoftwareInventories/GetSoftware_example.json
// this example is just showing the usage of "SoftwareInventories_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 SoftwareInventoryResource created on azure
// for more information of creating SoftwareInventoryResource, please refer to the document of SoftwareInventoryResource
string subscriptionId = "e5d1b86c-3051-44d5-8802-aa65d45a279b";
string resourceGroupName = "EITAN-TESTS";
string resourceNamespace = "Microsoft.Compute";
string resourceType = "virtualMachines";
string resourceName = "Eitan-Test1";
string softwareName = "outlook_16.0.10371.20060";
ResourceIdentifier softwareInventoryResourceId = SoftwareInventoryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, resourceNamespace, resourceType, resourceName, softwareName);
SoftwareInventoryResource softwareInventory = client.GetSoftwareInventoryResource(softwareInventoryResourceId);

// invoke the operation
SoftwareInventoryResource result = await softwareInventory.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SoftwareInventoryData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/EITAN-TESTS/providers/Microsoft.Compute/virtualMachines/Eitan-Test1/providers/Microsoft.Security/softwareInventories/outlook_16.0.10371.20060",
  "name": "outlook_16.0.10371.20060",
  "type": "Microsoft.Security/softwareInventories",
  "properties": {
    "deviceId": "7bd19ed6b07553e52a2844451bcec68d25963a53",
    "osPlatform": "Windows10",
    "vendor": "microsoft",
    "softwareName": "outlook",
    "version": "16.0.10371.20060",
    "endOfSupportStatus": "None",
    "numberOfKnownVulnerabilities": 0,
    "firstSeenAt": "2021-01-26 15:48:56"
  }
}

Definitions

Name	Description
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
EndOfSupportStatus	End of support status.
ErrorAdditionalInfo	The resource management error additional info.
Software	Represents a software data

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

EndOfSupportStatus

End of support status.

Name	Type	Description
None	string
noLongerSupported	string
upcomingNoLongerSupported	string
upcomingVersionNoLongerSupported	string
versionNoLongerSupported	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

Software

Represents a software data

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.deviceId	string	Unique identifier for the virtual machine in the service.
properties.endOfSupportDate	string	The end of support date in case the product is upcoming end of support.
properties.endOfSupportStatus	EndOfSupportStatus	End of support status.
properties.firstSeenAt	string	First time that the software was seen in the device.
properties.numberOfKnownVulnerabilities	integer	Number of weaknesses.
properties.osPlatform	string	Platform of the operating system running on the device.
properties.softwareName	string	Name of the software product.
properties.vendor	string	Name of the software vendor.
properties.version	string	Version number of the software product.
type	string	Resource type

Share via

Software Inventories - Get

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

Gets a single software data of the virtual machine

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

EndOfSupportStatus

ErrorAdditionalInfo

Software

Additional resources