Server Vulnerability Assessments Settings - Get

Servicio:

Defender for Cloud

Versión de la API:

2023-05-01

Obtener una configuración de evaluaciones de vulnerabilidades del servidor del tipo solicitado, que se establece en la suscripción

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/serverVulnerabilityAssessmentsSettings/azureServersSetting?api-version=2023-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
settingKind	path	True	ServerVulnerabilityAssessmentsSettingKindName	El tipo de configuración de las evaluaciones de vulnerabilidades del servidor
subscriptionId	path	True	string uuid	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ServerVulnerabilityAssessmentsSetting: AzureServersSetting	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get the server vulnerability assessments setting of the kind settingKind that is set on the subscription

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/serverVulnerabilityAssessmentsSettings/azureServersSetting?api-version=2023-05-01

Java

import com.azure.resourcemanager.security.models.ServerVulnerabilityAssessmentsSettingKindName;

/**
 * Samples for ServerVulnerabilityAssessmentsSettings Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2023-05-01/examples/
     * ServerVulnerabilityAssessmentsSettings/GetServerVulnerabilityAssessmentsSetting_example.json
     */
    /**
     * Sample code: Get the server vulnerability assessments setting of the kind settingKind that is set on the
     * subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getTheServerVulnerabilityAssessmentsSettingOfTheKindSettingKindThatIsSetOnTheSubscription(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.serverVulnerabilityAssessmentsSettings().getWithResponse(
            ServerVulnerabilityAssessmentsSettingKindName.AZURE_SERVERS_SETTING, 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

Go

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/stable/2023-05-01/examples/ServerVulnerabilityAssessmentsSettings/GetServerVulnerabilityAssessmentsSetting_example.json
func ExampleServerVulnerabilityAssessmentsSettingsClient_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.NewServerVulnerabilityAssessmentsSettingsClient().Get(ctx, armsecurity.ServerVulnerabilityAssessmentsSettingKindNameAzureServersSetting, 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 = armsecurity.ServerVulnerabilityAssessmentsSettingsClientGetResponse{
	// 	                            ServerVulnerabilityAssessmentsSettingClassification: &armsecurity.AzureServersSetting{
	// 		Name: to.Ptr("azureServersSetting"),
	// 		Type: to.Ptr("Microsoft.Security/serverVulnerabilityAssessmentsSettings"),
	// 		ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/serverVulnerabilityAssessmentsSettings/azureServersSetting"),
	// 		SystemData: &armsecurity.SystemData{
	// 			CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-05-12T13:47:50.328Z"); return t}()),
	// 			CreatedBy: to.Ptr("user@contoso.com"),
	// 			CreatedByType: to.Ptr(armsecurity.CreatedByTypeUser),
	// 			LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-05-12T13:47:50.328Z"); return t}()),
	// 			LastModifiedBy: to.Ptr("user@contoso.com"),
	// 			LastModifiedByType: to.Ptr(armsecurity.CreatedByTypeUser),
	// 		},
	// 		Kind: to.Ptr(armsecurity.ServerVulnerabilityAssessmentsSettingKindAzureServersSetting),
	// 		Properties: &armsecurity.ServerVulnerabilityAssessmentsAzureSettingProperties{
	// 			SelectedProvider: to.Ptr(armsecurity.ServerVulnerabilityAssessmentsAzureSettingSelectedProviderMdeTvm),
	// 		},
	// 	},
	// 	                        }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a server vulnerability assessments setting of the requested kind, that is set on the subscription
 *
 * @summary Get a server vulnerability assessments setting of the requested kind, that is set on the subscription
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2023-05-01/examples/ServerVulnerabilityAssessmentsSettings/GetServerVulnerabilityAssessmentsSetting_example.json
 */
async function getTheServerVulnerabilityAssessmentsSettingOfTheKindSettingKindThatIsSetOnTheSubscription() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const settingKind = "azureServersSetting";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.serverVulnerabilityAssessmentsSettings.get(settingKind);
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/stable/2023-05-01/examples/ServerVulnerabilityAssessmentsSettings/GetServerVulnerabilityAssessmentsSetting_example.json
// this example is just showing the usage of "ServerVulnerabilityAssessmentsSettings_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 ServerVulnerabilityAssessmentsSettingResource created on azure
// for more information of creating ServerVulnerabilityAssessmentsSettingResource, please refer to the document of ServerVulnerabilityAssessmentsSettingResource
string subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ServerVulnerabilityAssessmentsSettingKindName settingKind = ServerVulnerabilityAssessmentsSettingKindName.AzureServersSetting;
ResourceIdentifier serverVulnerabilityAssessmentsSettingResourceId = ServerVulnerabilityAssessmentsSettingResource.CreateResourceIdentifier(subscriptionId, settingKind);
ServerVulnerabilityAssessmentsSettingResource serverVulnerabilityAssessmentsSetting = client.GetServerVulnerabilityAssessmentsSettingResource(serverVulnerabilityAssessmentsSettingResourceId);

// invoke the operation
ServerVulnerabilityAssessmentsSettingResource result = await serverVulnerabilityAssessmentsSetting.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
ServerVulnerabilityAssessmentsSettingData 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

Respuesta de muestra

status code:

200

{
  "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/serverVulnerabilityAssessmentsSettings/azureServersSetting",
  "name": "azureServersSetting",
  "type": "Microsoft.Security/serverVulnerabilityAssessmentsSettings",
  "kind": "AzureServersSetting",
  "properties": {
    "selectedProvider": "MdeTvm"
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2023-05-12T13:47:50.328Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-05-12T13:47:50.328Z"
  }
}

Definiciones

Nombre	Description
AzureServersSetting	Configuración de evaluaciones de vulnerabilidades en servidores de Azure en el ámbito definido.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ServerVulnerabilityAssessmentsAzureSettingSelectedProvider	Proveedor de evaluaciones de vulnerabilidades seleccionado en servidores de Azure en el ámbito definido.
ServerVulnerabilityAssessmentsSettingKind	El tipo de configuración de las evaluaciones de vulnerabilidades del servidor
ServerVulnerabilityAssessmentsSettingKindName	El tipo de configuración de las evaluaciones de vulnerabilidades del servidor
systemData	Metadatos relativos a la creación y última modificación del recurso.

AzureServersSetting

Configuración de evaluaciones de vulnerabilidades en servidores de Azure en el ámbito definido.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: AzureServersSetting	El tipo de configuración de evaluaciones de vulnerabilidades del servidor.
name	string	Nombre del recurso
properties.selectedProvider	ServerVulnerabilityAssessmentsAzureSettingSelectedProvider	Proveedor de evaluaciones de vulnerabilidades seleccionado en servidores de Azure en el ámbito definido.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ServerVulnerabilityAssessmentsAzureSettingSelectedProvider

Proveedor de evaluaciones de vulnerabilidades seleccionado en servidores de Azure en el ámbito definido.

Nombre	Tipo	Description
MdeTvm	string	Administración de amenazas y vulnerabilidades de Microsoft Defender para puntos de conexión.

ServerVulnerabilityAssessmentsSettingKind

El tipo de configuración de las evaluaciones de vulnerabilidades del servidor

Nombre	Tipo	Description
AzureServersSetting	string

ServerVulnerabilityAssessmentsSettingKindName

El tipo de configuración de las evaluaciones de vulnerabilidades del servidor

Nombre	Tipo	Description
azureServersSetting	string

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.