Defender For Storage - Create

Référence

Service:: Defender for Cloud

API Version:: 2022-12-01-preview

Crée ou met à jour les paramètres Defender pour le stockage sur un compte de stockage spécifié.

PUT https://management.azure.com/{resourceId}/providers/Microsoft.Security/defenderForStorageSettings/current?api-version=2022-12-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
resourceId	path	True	string	Identificateur de la ressource.
settingName	path	True	settingName	Nom du paramètre Defender pour le stockage. Regex pattern: `^[a-z][a-z0-9]*$`
api-version	query	True	string	Version de l’API pour l’opération

resourceId

path

True

string

Identificateur de la ressource.

settingName

path

True

settingName

Nom du paramètre Defender pour le stockage.

Regex pattern: ^[a-z][a-z0-9]*$

api-version

query

True

string

Version de l’API pour l’opération

Corps de la demande

Nom	Type	Description
properties.isEnabled	boolean	Indique si Defender pour le stockage est activé sur ce compte de stockage.
properties.malwareScanning.onUpload.capGBPerMonth	integer	Définit le nombre maximal de Go à analyser par mois. Définissez sur -1 si aucun plafonnement n’est nécessaire.
properties.malwareScanning.onUpload.isEnabled	boolean	Indique si l’analyse des programmes malveillants lors du chargement doit être activée.
properties.malwareScanning.scanResultsEventGridTopicResourceId	string	facultatif. ID de ressource d’une rubrique Event Grid à laquelle envoyer les résultats de l’analyse.
properties.overrideSubscriptionLevelSettings	boolean	Indique si les paramètres définis pour ce compte de stockage doivent remplacer les paramètres définis pour l’abonnement.
properties.sensitiveDataDiscovery.isEnabled	boolean	Indique si la découverte des données sensibles doit être activée.

Réponses

Nom	Type	Description
200 OK	DefenderForStorageSetting	Demande de création ou de mise à jour des paramètres Defender pour le stockage réussie.
201 Created	DefenderForStorageSetting	La demande de création ou de mise à jour des paramètres Defender pour le stockage a partiellement réussi.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Creates or updates the Defender for Storage settings on a specified resource.

Sample Request

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/defenderForStorageSettings/current?api-version=2022-12-01-preview

{
  "properties": {
    "isEnabled": true,
    "malwareScanning": {
      "onUpload": {
        "isEnabled": true,
        "capGBPerMonth": -1
      },
      "scanResultsEventGridTopicResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic"
    },
    "sensitiveDataDiscovery": {
      "isEnabled": true
    },
    "overrideSubscriptionLevelSettings": true
  }
}


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

/**
 * Samples for DefenderForStorage Create.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/examples/DefenderForStorage
     * /PutDefenderForStorageSettings_example.json
     */
    /**
     * Sample code: Creates or updates the Defender for Storage settings on a specified resource.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createsOrUpdatesTheDefenderForStorageSettingsOnASpecifiedResource(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.defenderForStorages().define(SettingName.CURRENT).withExistingResourceId(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount")
            .withIsEnabled(true).withOverrideSubscriptionLevelSettings(true)
            .withScanResultsEventGridTopicResourceId(
                "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic")
            .withIsEnabledMalwareScanningIsEnabled(true).withCapGBPerMonth(-1)
            .withIsEnabledSensitiveDataDiscoveryIsEnabled(true).create();
    }
}

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/azcore/to"
	"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/2022-12-01-preview/examples/DefenderForStorage/PutDefenderForStorageSettings_example.json
func ExampleDefenderForStorageClient_Create() {
	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.NewDefenderForStorageClient().Create(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount", armsecurity.SettingNameCurrent, armsecurity.DefenderForStorageSetting{
		Properties: &armsecurity.DefenderForStorageSettingProperties{
			IsEnabled: to.Ptr(true),
			MalwareScanning: &armsecurity.MalwareScanningProperties{
				OnUpload: &armsecurity.OnUploadProperties{
					CapGBPerMonth: to.Ptr[int32](-1),
					IsEnabled:     to.Ptr(true),
				},
				ScanResultsEventGridTopicResourceID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic"),
			},
			OverrideSubscriptionLevelSettings: to.Ptr(true),
			SensitiveDataDiscovery: &armsecurity.SensitiveDataDiscoveryProperties{
				IsEnabled: to.Ptr(true),
			},
		},
	}, 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.DefenderForStorageSetting = armsecurity.DefenderForStorageSetting{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Security/defenderForStorageSettings"),
	// 	ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/defenderForStorageSettings/current"),
	// 	Properties: &armsecurity.DefenderForStorageSettingProperties{
	// 		IsEnabled: to.Ptr(true),
	// 		MalwareScanning: &armsecurity.MalwareScanningProperties{
	// 			OnUpload: &armsecurity.OnUploadProperties{
	// 				CapGBPerMonth: to.Ptr[int32](-1),
	// 				IsEnabled: to.Ptr(true),
	// 			},
	// 			OperationStatus: &armsecurity.OperationStatus{
	// 				Code: to.Ptr("Succeeded"),
	// 			},
	// 			ScanResultsEventGridTopicResourceID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic"),
	// 		},
	// 		OverrideSubscriptionLevelSettings: to.Ptr(true),
	// 		SensitiveDataDiscovery: &armsecurity.SensitiveDataDiscoveryProperties{
	// 			IsEnabled: to.Ptr(true),
	// 			OperationStatus: &armsecurity.OperationStatus{
	// 				Code: to.Ptr("Succeeded"),
	// 			},
	// 		},
	// 	},
	// }
}

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 Creates or updates the Defender for Storage settings on a specified storage account.
 *
 * @summary Creates or updates the Defender for Storage settings on a specified storage account.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/examples/DefenderForStorage/PutDefenderForStorageSettings_example.json
 */
async function createsOrUpdatesTheDefenderForStorageSettingsOnASpecifiedResource() {
  const resourceId =
    "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount";
  const settingName = "current";
  const defenderForStorageSetting = {
    capGBPerMonth: -1,
    isEnabledPropertiesMalwareScanningOnUploadIsEnabled: true,
    overrideSubscriptionLevelSettings: true,
    scanResultsEventGridTopicResourceId:
      "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic",
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.defenderForStorage.create(
    resourceId,
    settingName,
    defenderForStorageSetting,
  );
  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;
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/preview/2022-12-01-preview/examples/DefenderForStorage/PutDefenderForStorageSettings_example.json
// this example is just showing the usage of "DefenderForStorage_Create" 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 DefenderForStorageSettingResource created on azure
// for more information of creating DefenderForStorageSettingResource, please refer to the document of DefenderForStorageSettingResource
string resourceId = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount";
DefenderForStorageSettingName settingName = DefenderForStorageSettingName.Current;
ResourceIdentifier defenderForStorageSettingResourceId = DefenderForStorageSettingResource.CreateResourceIdentifier(resourceId, settingName);
DefenderForStorageSettingResource defenderForStorageSetting = client.GetDefenderForStorageSettingResource(defenderForStorageSettingResourceId);

// invoke the operation
DefenderForStorageSettingName settingName0 = DefenderForStorageSettingName.Current;
DefenderForStorageSettingData data = new DefenderForStorageSettingData()
{
    IsEnabled = true,
    IsOverrideSubscriptionLevelSettingsEnabled = true,
    IsSensitiveDataDiscoveryEnabled = true,
    ScanResultsEventGridTopicResourceId = new ResourceIdentifier("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic"),
    IsMalwareScanningOnUploadEnabled = true,
    CapGBPerMonth = -1,
};
ArmOperation<DefenderForStorageSettingResource> lro = await defenderForStorageSetting.UpdateAsync(WaitUntil.Completed, settingName0, data);
DefenderForStorageSettingResource result = lro.Value;

// 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
DefenderForStorageSettingData 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/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/defenderForStorageSettings/current",
  "type": "Microsoft.Security/defenderForStorageSettings",
  "name": "current",
  "properties": {
    "isEnabled": true,
    "malwareScanning": {
      "onUpload": {
        "isEnabled": true,
        "capGBPerMonth": -1
      },
      "scanResultsEventGridTopicResourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.EventGrid/topics/sampletopic",
      "operationStatus": {
        "code": "Succeeded"
      }
    },
    "sensitiveDataDiscovery": {
      "isEnabled": true,
      "operationStatus": {
        "code": "Succeeded"
      }
    },
    "overrideSubscriptionLevelSettings": true
  }
}

Status code:: 201

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/defenderForStorageSettings/current",
  "type": "Microsoft.Security/defenderForStorageSettings",
  "name": "current",
  "properties": {
    "isEnabled": true,
    "malwareScanning": {
      "onUpload": {
        "isEnabled": false,
        "capGBPerMonth": -1
      },
      "operationStatus": {
        "code": "UnknownError",
        "message": "Failed to setup data scanner."
      }
    },
    "sensitiveDataDiscovery": {
      "isEnabled": false,
      "operationStatus": {
        "code": "UnknownError",
        "message": "Failed to setup data scanner."
      }
    },
    "overrideSubscriptionLevelSettings": true
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
CloudErrorBody	Détail de l’erreur.
DefenderForStorageSetting	Ressource Defender pour le stockage.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
OperationStatus	Un status décrivant la réussite/l’échec de l’opération d’activation/désactivation.
settingName	Nom du paramètre Defender pour le stockage.

CloudError

Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
error.code	string	Code d'erreur.
error.details	CloudErrorBody[]	Détails de l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible d’erreur.

CloudErrorBody

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	CloudErrorBody[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

DefenderForStorageSetting

Ressource Defender pour le stockage.

Nom	Type	Description
id	string	ID de ressource
name	string	Nom de la ressource
properties.isEnabled	boolean	Indique si Defender pour le stockage est activé sur ce compte de stockage.
properties.malwareScanning.onUpload.capGBPerMonth	integer	Définit le nombre maximal de Go à analyser par mois. Définissez sur -1 si aucun plafonnement n’est nécessaire.
properties.malwareScanning.onUpload.isEnabled	boolean	Indique si l’analyse des programmes malveillants lors du chargement doit être activée.
properties.malwareScanning.operationStatus	OperationStatus	En cas d’échec ou de réussite partielle. Données supplémentaires décrivant l’opération d’activation/désactivation de l’analyse des programmes malveillants.
properties.malwareScanning.scanResultsEventGridTopicResourceId	string	facultatif. ID de ressource d’une rubrique Event Grid à laquelle envoyer les résultats de l’analyse.
properties.overrideSubscriptionLevelSettings	boolean	Indique si les paramètres définis pour ce compte de stockage doivent remplacer les paramètres définis pour l’abonnement.
properties.sensitiveDataDiscovery.isEnabled	boolean	Indique si la découverte des données sensibles doit être activée.
properties.sensitiveDataDiscovery.operationStatus	OperationStatus	En cas d’échec ou de réussite partielle. Données supplémentaires décrivant l’opération d’activation/désactivation de la découverte des données sensibles.
type	string	Type de ressource

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

OperationStatus

Un status décrivant la réussite/l’échec de l’opération d’activation/désactivation.

Nom	Type	Description
code	string	Opération status code.
message	string	Informations supplémentaires concernant la réussite/l’échec de l’opération.

settingName

Nom du paramètre Defender pour le stockage.

Nom	Type	Description
current	string	Nom du nom des paramètres defender pour le stockage.

Partager via

Defender For Storage - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Scopes

Exemples

Creates or updates the Defender for Storage settings on a specified resource.

Sample Request

Sample Response

Définitions

CloudError

CloudErrorBody

DefenderForStorageSetting

ErrorAdditionalInfo

OperationStatus

settingName

Ressources supplémentaires