Defender For Storage - Get

參考

服務:: Defender for Cloud

API 版本:: 2022-12-01-preview

取得指定記憶體帳戶的適用於記憶體的 Defender 設定。

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

URI 參數

名稱位於必要類型 Description

名稱	位於	必要	類型	Description
resourceId	path	True	string	資源的標識碼。
settingName	path	True	settingName	適用於記憶體的 Defender 設定名稱。 Regex 模式: `^[a-z][a-z0-9]*$`
api-version	query	True	string	作業的 API 版本

resourceId

path

True

string

資源的標識碼。

settingName

path

True

settingName

適用於記憶體的 Defender 設定名稱。

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

api-version

query

True

string

作業的 API 版本

回應

名稱	類型	Description
200 OK	DefenderForStorageSetting	成功要求以取得適用於記憶體的Defender設定。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Gets the Defender for Storage settings for the specified resource.

範例要求

GET 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


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

/**
 * Samples for DefenderForStorage Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/examples/DefenderForStorage
     * /GetDefenderForStorageSettings_example.json
     */
    /**
     * Sample code: Gets the Defender for Storage settings for the specified resource.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getsTheDefenderForStorageSettingsForTheSpecifiedResource(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.defenderForStorages().getWithResponse(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount",
            SettingName.CURRENT, 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

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/preview/2022-12-01-preview/examples/DefenderForStorage/GetDefenderForStorageSettings_example.json
func ExampleDefenderForStorageClient_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.NewDefenderForStorageClient().Get(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount", armsecurity.SettingNameCurrent, 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),
	// 			},
	// 			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(false),
	// 		},
	// 	},
	// }
}

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 Gets the Defender for Storage settings for the specified storage account.
 *
 * @summary Gets the Defender for Storage settings for the specified storage account.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-12-01-preview/examples/DefenderForStorage/GetDefenderForStorageSettings_example.json
 */
async function getsTheDefenderForStorageSettingsForTheSpecifiedResource() {
  const resourceId =
    "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount";
  const settingName = "current";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.defenderForStorage.get(resourceId, settingName);
  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/GetDefenderForStorageSettings_example.json
// this example is just showing the usage of "DefenderForStorage_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 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;
DefenderForStorageSettingResource result = await defenderForStorageSetting.GetAsync(settingName0);

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

範例回覆

狀態碼:: 200

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/defenderForStorageSettings/current",
  "name": "current",
  "type": "Microsoft.Security/defenderForStorageSettings",
  "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": false
    },
    "overrideSubscriptionLevelSettings": true
  }
}

定義

名稱	Description
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
DefenderForStorageSetting	適用於記憶體的Defender資源。
DefenderForStorageSettingProperties	適用於記憶體的 Defender 資源屬性。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
MalwareScanningProperties	惡意代碼掃描的屬性。
OnUploadProperties	上傳惡意代碼掃描的屬性。
OperationStatus	描述啟用/停用作業成功/失敗的狀態。
SensitiveDataDiscoveryProperties	敏感數據探索的屬性。
settingName	適用於記憶體的 Defender 設定名稱。

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細數據。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

DefenderForStorageSetting

適用於記憶體的Defender資源。

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties	DefenderForStorageSettingProperties	適用於記憶體的 Defender 資源屬性。
type	string	資源類型

DefenderForStorageSettingProperties

適用於記憶體的 Defender 資源屬性。

名稱	類型	Description
isEnabled	boolean	指出是否在此記憶體帳戶上啟用適用於記憶體的 Defender。
malwareScanning	MalwareScanningProperties	惡意代碼掃描的屬性。
overrideSubscriptionLevelSettings	boolean	指出此記憶體帳戶所定義的設定是否應該覆寫為訂用帳戶定義的設定。
sensitiveDataDiscovery	SensitiveDataDiscoveryProperties	敏感數據探索的屬性。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

MalwareScanningProperties

惡意代碼掃描的屬性。

名稱	類型	Description
onUpload	OnUploadProperties	上傳惡意代碼掃描的屬性。
operationStatus	OperationStatus	失敗或部分成功時。描述惡意代碼掃描啟用/停用作業的其他數據。
scanResultsEventGridTopicResourceId	string	自選。要傳送掃描結果的事件方格主題資源標識碼。

OnUploadProperties

上傳惡意代碼掃描的屬性。

名稱	類型	Description
capGBPerMonth	integer	定義每個月要掃描的最大 GB。如果不需要上限，請將設定為 -1。
isEnabled	boolean	指出是否應該啟用 [上傳惡意代碼掃描]。

OperationStatus

描述啟用/停用作業成功/失敗的狀態。

名稱	類型	Description
code	string	作業狀態代碼。
message	string	有關作業成功/失敗的其他資訊。

SensitiveDataDiscoveryProperties

敏感數據探索的屬性。

名稱	類型	Description
isEnabled	boolean	指出是否應該啟用敏感數據探索。
operationStatus	OperationStatus	失敗或部分成功時。描述敏感數據探索啟用/停用作業的其他數據。

settingName

適用於記憶體的 Defender 設定名稱。

名稱	類型	Description
current	string	適用於記憶體的 Defender 設定名稱。

共用方式為

Defender For Storage - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

Gets the Defender for Storage settings for the specified resource.

範例要求

範例回覆

定義

CloudError

CloudErrorBody

DefenderForStorageSetting

DefenderForStorageSettingProperties

ErrorAdditionalInfo

MalwareScanningProperties

OnUploadProperties

OperationStatus

SensitiveDataDiscoveryProperties

settingName

其他資源