Tasks - List By Resource Group

Service:

Defender for Cloud

API Version:

2015-06-01-preview

Recommended tasks that will help improve the security of the subscription proactively

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks?api-version=2015-06-01-preview

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/tasks?api-version=2015-06-01-preview&$filter={$filter}

URI Parameters

Name	In	Required	Type	Description
ascLocation	path	True	string	The location where ASC stores the data of the subscription. can be retrieved from Get locations
resourceGroupName	path	True	string	The name of the resource group within the user's subscription. The name is case insensitive. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure subscription ID Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	API version for the operation
$filter	query		string	OData filter. Optional.

Responses

Name	Type	Description
200 OK	SecurityTaskList	OK
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

Get security recommendation tasks in a resource group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks?api-version=2015-06-01-preview

Java

import com.azure.core.util.Context;

/** Samples for Tasks ListByResourceGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json
     */
    /**
     * Sample code: Get security recommendation tasks in a resource group.
     *
     * @param manager Entry point to SecurityManager.
     */
    public static void getSecurityRecommendationTasksInAResourceGroup(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.tasks().listByResourceGroup("myRg", "westeurope", null, 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

Go

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/tree/main/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json
func ExampleTasksClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armsecurity.NewTasksClient("20ff7fc3-e762-44dd-bd96-b71116dcdc23", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("myRg", "westeurope", &armsecurity.TasksClientListByResourceGroupOptions{Filter: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Recommended tasks that will help improve the security of the subscription proactively
 *
 * @summary Recommended tasks that will help improve the security of the subscription proactively
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Tasks/GetTasksResourceGroupLocation_example.json
 */
async function getSecurityRecommendationTasksInAResourceGroup() {
  const subscriptionId = "20ff7fc3-e762-44dd-bd96-b71116dcdc23";
  const resourceGroupName = "myRg";
  const ascLocation = "westeurope";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.tasks.listByResourceGroup(resourceGroupName, ascLocation)) {
    resArray.push(item);
  }
  console.log(resArray);
}

getSecurityRecommendationTasksInAResourceGroup().catch(console.error);

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

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Security/locations/westeurope/tasks/d55b4dc0-779c-c66c-33e5-d7bce24c4222",
      "name": "d55b4dc0-779c-c66c-33e5-d7bce24c4222",
      "type": "Microsoft.Security/locations/tasks",
      "properties": {
        "state": "Active",
        "subState": "NA",
        "creationTimeUtc": "2018-04-02T11:41:27.0541014Z",
        "lastStateChangeTimeUtc": "2018-04-02T11:41:27.0541014Z",
        "securityTaskParameters": {
          "vmId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1",
          "vmName": "vm1",
          "severity": "High",
          "isOsDiskEncrypted": false,
          "isDataDiskEncrypted": false,
          "name": "EncryptionOnVm",
          "uniqueKey": "EncryptionOnVmTaskParameters_/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1",
          "resourceId": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1"
        }
      }
    }
  ]
}

Definitions

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.
SecurityTask	Security task that we recommend to do in order to strengthen security
SecurityTaskList	List of security task recommendations
SecurityTaskParameters	Changing set of properties, depending on the task type that is derived from the name field

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.).

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

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

The resource management error additional info.

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

SecurityTask

Security task that we recommend to do in order to strengthen security

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.creationTimeUtc	string	The time this task was discovered in UTC
properties.lastStateChangeTimeUtc	string	The time this task's details were last changed in UTC
properties.securityTaskParameters	SecurityTaskParameters	Changing set of properties, depending on the task type that is derived from the name field
properties.state	string	State of the task (Active, Resolved etc.)
properties.subState	string	Additional data on the state of the task
type	string	Resource type

SecurityTaskList

List of security task recommendations

Name	Type	Description
nextLink	string	The URI to fetch the next page.
value	SecurityTask[]	Security task that we recommend to do in order to strengthen security

SecurityTaskParameters

Changing set of properties, depending on the task type that is derived from the name field

Name	Type	Description
name	string	Name of the task type