Defender For Storage - Create

Reference

Service:: Defender for Cloud

API Version:: 2022-12-01-preview

Vytvoří nebo aktualizuje nastavení Defenderu pro úložiště v zadaném účtu úložiště.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
resourceId	path	True	string	Identifikátor prostředku.
settingName	path	True	settingName	Název nastavení Defenderu for Storage. Regex pattern: `^[a-z][a-z0-9]*$`
api-version	query	True	string	Verze rozhraní API pro operaci

resourceId

path

True

string

Identifikátor prostředku.

settingName

path

True

settingName

Název nastavení Defenderu for Storage.

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

api-version

query

True

string

Verze rozhraní API pro operaci

Text požadavku

Name	Typ	Description
properties.isEnabled	boolean	Určuje, jestli je pro tento účet úložiště povolený Defender for Storage.
properties.malwareScanning.onUpload.capGBPerMonth	integer	Definuje maximální počet GB, který se má kontrolovat za měsíc. Pokud není potřeba žádné omezení, nastavte na hodnotu -1.
properties.malwareScanning.onUpload.isEnabled	boolean	Určuje, jestli má být povolená kontrola malwaru při odesílání.
properties.malwareScanning.scanResultsEventGridTopicResourceId	string	Nepovinný parametr. ID prostředku tématu Event Gridu, do které se mají odesílat výsledky kontroly.
properties.overrideSubscriptionLevelSettings	boolean	Určuje, jestli by nastavení definovaná pro tento účet úložiště měla přepsat nastavení definovaná pro předplatné.
properties.sensitiveDataDiscovery.isEnabled	boolean	Určuje, jestli má být povolené zjišťování citlivých dat.

Odpovědi

Name	Typ	Description
200 OK	DefenderForStorageSetting	Žádost o vytvoření nebo aktualizaci nastavení Defenderu pro úložiště byla úspěšná.
201 Created	DefenderForStorageSetting	Žádost o vytvoření nebo aktualizaci nastavení Defenderu pro úložiště byla částečně úspěšná.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

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

Příklady

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

Definice

Name	Description
CloudError	Běžná odpověď na chybu pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (To také odpovídá formátu odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
DefenderForStorageSetting	Prostředek Defenderu pro úložiště.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
OperationStatus	Stav popisující úspěch/selhání operace povolení/zakázání.
settingName	Název nastavení Defenderu for Storage.

CloudError

Běžná odpověď na chybu pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (To také odpovídá formátu odpovědi na chybu OData.)

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

CloudErrorBody

Podrobnosti o chybě.

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

DefenderForStorageSetting

Prostředek Defenderu pro úložiště.

Name	Typ	Description
id	string	ID prostředku
name	string	Název prostředku
properties.isEnabled	boolean	Určuje, jestli je pro tento účet úložiště povolený Defender for Storage.
properties.malwareScanning.onUpload.capGBPerMonth	integer	Definuje maximální počet GB, který se má kontrolovat za měsíc. Pokud není potřeba žádné omezení, nastavte na hodnotu -1.
properties.malwareScanning.onUpload.isEnabled	boolean	Určuje, jestli má být povolená kontrola malwaru při odesílání.
properties.malwareScanning.operationStatus	OperationStatus	Při selhání nebo částečném úspěchu. Další data popisující operaci povolení/zakázání kontroly malwaru
properties.malwareScanning.scanResultsEventGridTopicResourceId	string	Nepovinný parametr. ID prostředku tématu Event Gridu, do které se mají odesílat výsledky kontroly.
properties.overrideSubscriptionLevelSettings	boolean	Určuje, jestli by nastavení definovaná pro tento účet úložiště měla přepsat nastavení definovaná pro předplatné.
properties.sensitiveDataDiscovery.isEnabled	boolean	Určuje, jestli má být povolené zjišťování citlivých dat.
properties.sensitiveDataDiscovery.operationStatus	OperationStatus	Při selhání nebo částečném úspěchu. Další data popisující operaci povolení/zakázání zjišťování citlivých dat
type	string	Typ prostředku

ErrorAdditionalInfo

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

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

OperationStatus

Stav popisující úspěch/selhání operace povolení/zakázání.

Name	Typ	Description
code	string	Stavový kód operace.
message	string	Další informace týkající se úspěchu nebo selhání operace

settingName

Název nastavení Defenderu for Storage.

Name	Typ	Description
current	string	Název nastavení Defenderu pro úložiště.

Sdílet prostřednictvím

Defender For Storage - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Scopes

Příklady

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

Sample Request

Sample Response

Definice

CloudError

CloudErrorBody

DefenderForStorageSetting

ErrorAdditionalInfo

OperationStatus

settingName

Další materiály