Defender For Storage - Get

Reference

Služba:: Defender for Cloud

Verze rozhraní API:: 2022-12-01-preview

Získá nastavení Defenderu pro úložiště pro zadaný účet úložiště.

GET 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 pro úložiště Vzor regulárního výrazu: `^[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 pro úložiště

Vzor regulárního výrazu: ^[a-z][a-z0-9]*$

api-version

query

True

string

Verze rozhraní API pro operaci

Odpovědi

Name	Typ	Description
200 OK	DefenderForStorageSetting	Úspěšná žádost o získání nastavení Defenderu pro úložiště
Other Status Codes	CloudError	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

Gets the Defender for Storage settings for the specified resource.

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Name	Description
CloudError	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
DefenderForStorageSetting	Prostředek Defenderu pro úložiště.
DefenderForStorageSettingProperties	Vlastnosti prostředku Defender for Storage
ErrorAdditionalInfo	Další informace o chybě správy prostředků
MalwareScanningProperties	Vlastnosti kontroly malwaru.
OnUploadProperties	Vlastnosti Kontroly malwaru při nahrávání
OperationStatus	Stav popisující úspěch nebo selhání operace povolení nebo zakázání.
SensitiveDataDiscoveryProperties	Vlastnosti zjišťování citlivých dat
settingName	Název nastavení Defenderu pro úložiště

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem 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	DefenderForStorageSettingProperties	Vlastnosti prostředku Defender for Storage
type	string	Typ prostředku

DefenderForStorageSettingProperties

Vlastnosti prostředku Defender for Storage

Name	Typ	Description
isEnabled	boolean	Určuje, jestli je pro tento účet úložiště povolený Defender for Storage.
malwareScanning	MalwareScanningProperties	Vlastnosti kontroly malwaru.
overrideSubscriptionLevelSettings	boolean	Určuje, jestli mají nastavení definovaná pro tento účet úložiště přepsat nastavení definovaná pro předplatné.
sensitiveDataDiscovery	SensitiveDataDiscoveryProperties	Vlastnosti zjišťování citlivých dat

ErrorAdditionalInfo

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

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

MalwareScanningProperties

Vlastnosti kontroly malwaru.

Name	Typ	Description
onUpload	OnUploadProperties	Vlastnosti Kontroly malwaru při nahrávání
operationStatus	OperationStatus	Při selhání nebo částečném úspěchu. Další data popisující operaci povolení/zakázání kontroly malwaru
scanResultsEventGridTopicResourceId	string	Volitelný. ID prostředku tématu Event Gridu pro odesílání výsledků kontroly.

OnUploadProperties

Vlastnosti Kontroly malwaru při nahrávání

Name	Typ	Description
capGBPerMonth	integer	Definuje maximální GB, které se má kontrolovat za měsíc. Pokud není potřeba omezení, nastavte -1.
isEnabled	boolean	Určuje, jestli má být povolená kontrola malwaru při nahrávání.

OperationStatus

Stav popisující úspěch nebo selhání operace povolení nebo 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

SensitiveDataDiscoveryProperties

Vlastnosti zjišťování citlivých dat

Name	Typ	Description
isEnabled	boolean	Určuje, jestli má být povolené zjišťování citlivých dat.
operationStatus	OperationStatus	Při selhání nebo částečném úspěchu. Další data popisující operaci povolení nebo zakázání zjišťování citlivých dat

settingName

Název nastavení Defenderu pro úložiště

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

Sdílet prostřednictvím

Defender For Storage - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Gets the Defender for Storage settings for the specified resource.

Ukázkový požadavek

Ukázková odpověď

Definice

CloudError

CloudErrorBody

DefenderForStorageSetting

DefenderForStorageSettingProperties

ErrorAdditionalInfo

MalwareScanningProperties

OnUploadProperties

OperationStatus

SensitiveDataDiscoveryProperties

settingName

Další materiály