Software Inventories - Get

Referência

Serviço:: Defender for Cloud

Versão da API:: 2021-05-01-preview

Obtém um único dado de software da máquina virtual.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário. O nome não diferencia maiúsculas de minúsculas. Padrão Regex: `^[-\w\._]+$`
resourceName	path	True	string	Nome do recurso.
resourceNamespace	path	True	string	O namespace do recurso.
resourceType	path	True	string	O tipo do recurso.
softwareName	path	True	string	Nome do software instalado.
subscriptionId	path	True	string	ID da assinatura do Azure Padrão Regex: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versão da API para a operação

Respostas

Nome	Tipo	Description
200 OK	Software	OKEY
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Gets a single software data of the virtual machine

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
  }
}

Definições

Nome	Description
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
EndOfSupportStatus	Fim do status de suporte.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
Software	Representa dados de software

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

EndOfSupportStatus

Fim do status de suporte.

Nome	Tipo	Description
None	string
noLongerSupported	string
upcomingNoLongerSupported	string
upcomingVersionNoLongerSupported	string
versionNoLongerSupported	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

Software

Representa dados de software

Nome	Tipo	Description
id	string	ID do recurso
name	string	Nome do recurso
properties.deviceId	string	Identificador exclusivo para a máquina virtual no serviço.
properties.endOfSupportDate	string	O fim da data de suporte, caso o produto seja o próximo fim do suporte.
properties.endOfSupportStatus	EndOfSupportStatus	Fim do status de suporte.
properties.firstSeenAt	string	Primeira vez que o software foi visto no dispositivo.
properties.numberOfKnownVulnerabilities	integer	Número de pontos fracos.
properties.osPlatform	string	Plataforma do sistema operacional em execução no dispositivo.
properties.softwareName	string	Nome do produto de software.
properties.vendor	string	Nome do fornecedor de software.
properties.version	string	Número de versão do produto de software.
type	string	Tipo de recurso

Compartilhar via

Software Inventories - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Gets a single software data of the virtual machine

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

CloudErrorBody

EndOfSupportStatus

ErrorAdditionalInfo

Software

Recursos adicionais