Software Inventories - Get

參考

服務:: Defender for Cloud

API 版本:: 2021-05-01-preview

取得虛擬機的單一軟體數據。

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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。名稱不區分大小寫。 Regex 模式: `^[-\w\._]+$`
resourceName	path	True	string	資源的名稱。
resourceNamespace	path	True	string	資源的命名空間。
resourceType	path	True	string	資源的型別。
softwareName	path	True	string	已安裝軟體的名稱。
subscriptionId	path	True	string	Azure 訂用帳戶標識碼 Regex 模式: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	作業的 API 版本

回應

名稱	類型	Description
200 OK	Software	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Gets a single software data of the virtual machine

範例要求

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

範例回覆

狀態碼:: 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"
  }
}

定義

名稱	Description
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
EndOfSupportStatus	終止支持狀態。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
Software	表示軟體數據

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細數據。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

EndOfSupportStatus

終止支持狀態。

名稱	類型	Description
None	string
noLongerSupported	string
upcomingNoLongerSupported	string
upcomingVersionNoLongerSupported	string
versionNoLongerSupported	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

Software

表示軟體數據

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.deviceId	string	服務中虛擬機的唯一標識符。
properties.endOfSupportDate	string	如果產品即將終止支援，則終止支援日期。
properties.endOfSupportStatus	EndOfSupportStatus	終止支持狀態。
properties.firstSeenAt	string	第一次在裝置中看到軟體。
properties.numberOfKnownVulnerabilities	integer	弱點數目。
properties.osPlatform	string	在裝置上執行的作業系統平臺。
properties.softwareName	string	軟體產品的名稱。
properties.vendor	string	軟體廠商的名稱。
properties.version	string	軟體產品的版本號碼。
type	string	資源類型

共用方式為

Software Inventories - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

Gets a single software data of the virtual machine

範例要求

範例回覆

定義

CloudError

CloudErrorBody

EndOfSupportStatus

ErrorAdditionalInfo

Software

其他資源