Server Vulnerability Assessments Settings - Get

Služba:

Defender for Cloud

Verze rozhraní API:

2023-05-01

Získání nastavení posouzení ohrožení zabezpečení serveru požadovaného typu nastaveného v předplatném

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
settingKind	path	True	ServerVulnerabilityAssessmentsSettingKindName	Druh nastavení posouzení ohrožení zabezpečení serveru
subscriptionId	path	True	string uuid	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	ServerVulnerabilityAssessmentsSetting: AzureServersSetting	OK
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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"
  }
}

Definice

Name	Description
AzureServersSetting	Nastavení posouzení ohrožení zabezpečení na serverech Azure v definovaném oboru
createdByType	Typ identity, která prostředek vytvořila.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
ServerVulnerabilityAssessmentsAzureSettingSelectedProvider	Vybraný poskytovatel posouzení ohrožení zabezpečení na serverech Azure v definovaném oboru.
ServerVulnerabilityAssessmentsSettingKind	Druh nastavení posouzení ohrožení zabezpečení serveru
ServerVulnerabilityAssessmentsSettingKindName	Druh nastavení posouzení ohrožení zabezpečení serveru
systemData	Metadata týkající se vytvoření a poslední změny prostředku.

AzureServersSetting

Nastavení posouzení ohrožení zabezpečení na serverech Azure v definovaném oboru

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Například /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string: AzureServersSetting	Druh nastavení posouzení ohrožení zabezpečení serveru.
name	string	Název prostředku
properties.selectedProvider	ServerVulnerabilityAssessmentsAzureSettingSelectedProvider	Vybraný poskytovatel posouzení ohrožení zabezpečení na serverech Azure v definovaném oboru.
systemData	systemData	Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

createdByType

Typ identity, která prostředek vytvořila.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ServerVulnerabilityAssessmentsAzureSettingSelectedProvider

Vybraný poskytovatel posouzení ohrožení zabezpečení na serverech Azure v definovaném oboru.

Name	Typ	Description
MdeTvm	string	Správa hrozeb a ohrožení zabezpečení v programu Microsoft Defender for Endpoints

ServerVulnerabilityAssessmentsSettingKind

Druh nastavení posouzení ohrožení zabezpečení serveru

Name	Typ	Description
AzureServersSetting	string

ServerVulnerabilityAssessmentsSettingKindName

Druh nastavení posouzení ohrožení zabezpečení serveru

Name	Typ	Description
azureServersSetting	string

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC).
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která prostředek vytvořila.
lastModifiedAt	string	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.