Azure Internal Scan Parameters

action={create|update}

Required

Specify create to configure a new internal Azure scan job. Specify update to make changes to an existing scan job.

id={value}

Required and only applicable for Update request

The ID of the scan schedule you want to update.

module={vm}

Required for Create request

Specify vm for a vulnerability scan.

cloud_provider={azure}  

Required

Specify azure for an Azure internal scan. The cloud_provider value cannot be changed during an update request.

Currently supporting azure only.

cloud_service={vm}

Required

Specify vm (Azure virtual machine) for an Azure internal scan. 
The cloud_service value cannot be changed during an update request.

connector_name={value}

Required

The name of the connector to be used. We check if the specified connector_name exists for your Qualys subscription.
If the specified connector name does not exists in your Qualys subscription, then the API request returns an error message - Invalid connector_name provided.

One of these parameters must be specified in the request: conector_name or connector_uuid. These are mutually exclusive and cannot be specified in the same request.

connector_uuid={value}

Required

The ID of the connector to be used. If the specified connector name does not exists in your Qualys subscription, then the API request returns an error message - Invalid connector_uuid provided. 

One of these parameters must be specified in the request: conector_name or connector_uuid. These are mutually exclusive and cannot be specified in the same request.

scan_title={value}

Required

The scan title to create.

active={0|1}

Required for Create request

Specify 1 to create an active schedule. Specify 0 to create an inactive schedule.

option_title={value}

Required

The title of the option profile to be used.

One of these parameters must be specified in the request: option_title or option_id. These are mutually exclusive and cannot be specified in the same request.

option_id={value}

Required

The ID of the option profile to be used.

One of these parameters must be specified in a request: option_title or option_id. These are mutually exclusive and cannot be specified in the same request.

priority={value}

Optional

Specify a value of 0 - 9 to set a processing priority level for the scan. When not specified, a value of 0 (no priority) is used. Valid values are:

0 = No Priority (the default)

1 = Emergency

2 = Ultimate

3 = Critical

4 = Major

5 = High

6 = Standard

7 = Medium

8 = Minor

9 = Low

iscanner_id={value}

Required

The IDs of the scanner appliances to be used. Multiple entries are comma separated.

These parameters cannot be specified in the same request: iscanner_id and iscanner_name.

iscanner_name={value}

Required

The friendly names of the scanner appliances to be used. Multiple entries are comma separated.

These parameters cannot be specified in the same request: iscanner_id and iscanner_name.

platform_type={location|virtual_network}

Required

Select the platform type as either location or virtual network.

region_code={value}

Required

The Azure region code. Valid values are:
ap-northeast-1, ap-southeast-1, ap-southeast-2, ap-east-1, eu-west-1, eu-north-1, asa-east-1, us-east-1, us-west-1, us-west-2,  me-south-1, eu-south-1, and af-south-1

This parameter is mandatory when the platform type is set to location.

virtual_network_id={value}

Required

Provide the Id of the Azure virtual network.

This parameter is mandatory when the platform type is set to virtual network.

tag_include_selector={all|any}

Optional

Select any (the default) to include hosts that match at least one of the selected tags. Select all to include hosts that match all of the selected tags.

tag_exclude_selector={all|any}

Optional

Select any (the default) to exclude hosts that match at least one of the selected tags. Select all to exclude hosts that match all of the selected tags.

tag_set_by={id|name}

Optional

Specify “id” (the default) to select a tag set by providing tag IDs. Specify “name” to select a tag set by providing tag names. We will check if the tag ids or tag names are valid.

tag_set_include={value}

Optional

Specify a tag set to include. Hosts that match these tags will be included. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated.

tag_set_exclude={value}

Optional

Specify a tag set to exclude. Hosts that match these tags will be excluded. You identify the tag set by providing tag name or IDs. Multiple entries are comma separated.

cloud_resource_ids={remove|any VM ID}

Optional

Only applicable for Update request.

Specific VM IDs on which scan needs to be launched (VM IDs are comma separated).

Specify remove to delete the existing VM-IDs.

Specify any VM ID to replace the existing VM-IDs.

schedule={now|recurring}

Required for Create request

Specify now to schedule the scan job for now.

Specify recurring to schedule the scan job to start at a later time or on a recurring basis. See Schedule Parameters for Azure Internal Scans. .