Defender For Storage - Start Malware Scan

Service:

Defender for Cloud

API Version:

2024-10-01-preview

Initiate a Defender for Storage malware scan for the specified storage account.

POST https://management.azure.com/{resourceId}/providers/Microsoft.Security/defenderForStorageSettings/current/startMalwareScan?api-version=2024-10-01-preview

URI Parameters

Name	In	Required	Type	Description
resourceId	path	True	string	The identifier of the resource.
settingName	path	True	settingName pattern: ^[a-z][a-z0-9]*$	Defender for Storage setting name.
api-version	query	True	string	API version for the operation

Responses

Name	Type	Description
200 OK	MalwareScan	The status of the malware scan operation.
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Initiate a Defender for Storage malware scan for the specified storage account.

Sample request

HTTP

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

Java

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

/**
 * Samples for DefenderForStorage StartMalwareScan.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-10-01-preview/examples/DefenderForStorage
     * /StartMalwareScan_example.json
     */
    /**
     * Sample code: Initiate a Defender for Storage malware scan for the specified storage account.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void initiateADefenderForStorageMalwareScanForTheSpecifiedStorageAccount(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.defenderForStorages().startMalwareScanWithResponse(
            "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

Sample response

Status code:

200

{
  "properties": {
    "scanId": "fc831479-412f-4bc2-8333-a8edda751a80",
    "scanStatus": "Queued",
    "scanStatusMessage": "The scan request has been queued for scanning"
  }
}

Definitions

Name	Description
BlobsScanSummary	A summary of the scan results of the blobs that were scanned.
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
ErrorAdditionalInfo	The resource management error additional info.
MalwareScan	Describes the state of a malware scan operation.
MalwareScanProperties
ScanSummary	A summary of the scan results.
settingName	Defender for Storage setting name.

BlobsScanSummary

Object

A summary of the scan results of the blobs that were scanned.

Name	Type	Description
maliciousBlobsCount	integer (int64)	The number of malicious blobs that were detected during the scan.
scannedBlobsInGB	number (double)	The number of gigabytes of data that were scanned.
skippedBlobsCount	integer (int64)	The number of blobs that were skipped.
totalBlobsScanned	integer (int64)	The total number of blobs that were scanned.

CloudError

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

MalwareScan

Object

Describes the state of a malware scan operation.

Name	Type	Description
properties	MalwareScanProperties

MalwareScanProperties

Object

Name	Type	Description
scanEndTime	string	The time at which the scan has ended. Only available for a scan which has terminated.
scanId	string	The identifier of the scan.
scanStartTime	string	The time at which the scan had been initiated.
scanStatus	string	A status code of the scan operation.
scanStatusMessage	string	A description of the status of the scan.
scanSummary	ScanSummary	A summary of the scan results.

ScanSummary

Object

A summary of the scan results.

Name	Type	Description
blobs	BlobsScanSummary	A summary of the scan results of the blobs that were scanned.
estimatedScanCostUSD	number (double)	The estimated cost of the scan. Only available for a scan which has terminated.

settingName

Enumeration

Defender for Storage setting name.

Value	Description
current	Name of the Defender for Storage Settings name.