Get Security Tasks (GET Collection)

 

Published: July 12, 2016

Updated: July 12, 2016

Retrieves all tasks for the subscription.

Method

GET

https://<endpoint>/subscriptions/{subscriptionId}/providers/microsoft.Security/tasks?api-version={api-version}

Parameter

Description

subscriptionId

The subscription id

Api-version

The version of the Security RP protocol used for this request

Common request headers only.

If successful, the operation returns HTTP status code of 200 (OK).

Copy 
{ 
  “value”:
  [
    {
        "id": "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Security/tasks/{id}",
        “type”: “Microsoft.Security/tasks”, 
        “name”: {id} , 
        “properties”: 
        {  
          "state": "Active",
          "creationTimeUtc": "2015-06-09T10:52:04.6487626Z",
          "securityTaskParameters": {
              "vmId": "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.ClassicCompute/virtualMachines/{name}",
             "vmName": "{name}",
             "domainName": "{domain-name}",
             "endpointName": "{endpoint-name}",
             "endpointPublicPort": {port},
             "name": "Configure ACL",
           }
        }
    },
   {
        "id": "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Security }/tasks/{id}",
        “type”: “Microsoft.Security/locations/tasks”, 
        “name”: {id} , 
        “properties”: 
        {  
          "state": "Active",
          "creationTimeUtc": "2015-06-09T10:52:04.6487626Z",
          "securityTaskParameters": {
              "vmId": "/subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.ClassicCompute/virtualMachines/{name}",
              "vmName": "{name}",
              "name": "Install Antimalware"
           }
        }
    },
], }

Parameter

Description

Id

A unique identifier for the task

Type

Type of task – options are { ProvisionWaf, ConfigureACLs, InstallAM, EnableDataCollection, EnableAutoPatch, InstalledNgfw } (more TBD)

Description

Task description

State

Task status – options are { Active, In Progress, Resolved, Dismissed, Closed }

Security Task Parameters

A property bag (key-value pairs) of custom properties for the specific task. Name indicates the type of task – can be { Configure ACLs, Provision WAF, Install Antimalware, Enable Data Collection, Install VM Agent, and more… }

Show: