Defender For Storage - Create

Odwołanie

Service:: Defender for Cloud

API Version:: 2022-12-01-preview

Tworzy lub aktualizuje ustawienia usługi Defender for Storage na określonym koncie magazynu.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
resourceId	path	True	string	Identyfikator zasobu.
settingName	path	True	settingName	Nazwa ustawienia usługi Defender for Storage. Regex pattern: `^[a-z][a-z0-9]*$`
api-version	query	True	string	Wersja interfejsu API dla operacji

resourceId

path

True

string

Identyfikator zasobu.

settingName

path

True

settingName

Nazwa ustawienia usługi Defender for Storage.

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

api-version

query

True

string

Wersja interfejsu API dla operacji

Treść żądania

Nazwa	Typ	Opis
properties.isEnabled	boolean	Wskazuje, czy usługa Defender for Storage jest włączona na tym koncie magazynu.
properties.malwareScanning.onUpload.capGBPerMonth	integer	Definiuje maksymalną liczbę GB do skanowania na miesiąc. Ustaw wartość -1, jeśli nie jest wymagane ograniczenie.
properties.malwareScanning.onUpload.isEnabled	boolean	Wskazuje, czy podczas przekazywania skanowania złośliwego oprogramowania powinno być włączone.
properties.malwareScanning.scanResultsEventGridTopicResourceId	string	Opcjonalny. Identyfikator zasobu tematu usługi Event Grid do wysyłania wyników skanowania do.
properties.overrideSubscriptionLevelSettings	boolean	Wskazuje, czy ustawienia zdefiniowane dla tego konta magazynu powinny zastąpić ustawienia zdefiniowane dla subskrypcji.
properties.sensitiveDataDiscovery.isEnabled	boolean	Wskazuje, czy należy włączyć odnajdywanie danych poufnych.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DefenderForStorageSetting	Pomyślne żądanie utworzenia lub zaktualizowania ustawień usługi Defender for Storage.
201 Created	DefenderForStorageSetting	Żądanie utworzenia lub zaktualizowania ustawień usługi Defender for Storage częściowo powiodło się.
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

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

Definicje

Nazwa	Opis
CloudError	Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).
CloudErrorBody	Szczegóły błędu.
DefenderForStorageSetting	Zasób usługi Defender for Storage.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
OperationStatus	Stan opisujący powodzenie/niepowodzenie operacji włączania/wyłączania.
settingName	Nazwa ustawienia usługi Defender for Storage.

CloudError

Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

DefenderForStorageSetting

Zasób usługi Defender for Storage.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa zasobu
properties.isEnabled	boolean	Wskazuje, czy usługa Defender for Storage jest włączona na tym koncie magazynu.
properties.malwareScanning.onUpload.capGBPerMonth	integer	Definiuje maksymalną liczbę GB do skanowania na miesiąc. Ustaw wartość -1, jeśli nie jest wymagane ograniczenie.
properties.malwareScanning.onUpload.isEnabled	boolean	Wskazuje, czy podczas przekazywania skanowania złośliwego oprogramowania powinno być włączone.
properties.malwareScanning.operationStatus	OperationStatus	Po niepowodzeniu lub częściowym powodzeniu. Dodatkowe dane opisujące operację włączania/wyłączania skanowania złośliwego oprogramowania.
properties.malwareScanning.scanResultsEventGridTopicResourceId	string	Opcjonalny. Identyfikator zasobu tematu usługi Event Grid do wysyłania wyników skanowania do.
properties.overrideSubscriptionLevelSettings	boolean	Wskazuje, czy ustawienia zdefiniowane dla tego konta magazynu powinny zastąpić ustawienia zdefiniowane dla subskrypcji.
properties.sensitiveDataDiscovery.isEnabled	boolean	Wskazuje, czy należy włączyć odnajdywanie danych poufnych.
properties.sensitiveDataDiscovery.operationStatus	OperationStatus	Po niepowodzeniu lub częściowym powodzeniu. Dodatkowe dane opisujące operację włączania/wyłączania odnajdywania danych poufnych.
type	string	Typ zasobu

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

OperationStatus

Stan opisujący powodzenie/niepowodzenie operacji włączania/wyłączania.

Nazwa	Typ	Opis
code	string	Kod stanu operacji.
message	string	Dodatkowe informacje dotyczące powodzenia/niepowodzenia operacji.

settingName

Nazwa ustawienia usługi Defender for Storage.

Nazwa	Typ	Opis
current	string	Nazwa nazwy ustawień usługi Defender for Storage.

Udostępnij za pośrednictwem

Defender For Storage - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

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

Sample Request

Sample Response

Definicje

CloudError

CloudErrorBody

DefenderForStorageSetting

ErrorAdditionalInfo

OperationStatus

settingName

Dodatkowe zasoby