Azure MS SQL record

action={action}

(Required) Specify create, update, delete (using POST) or list (using GET or POST).

echo_request={0|1}

(Optional) Set to 1 to view the request’s input parameters (names and values) in the XML output. By default parameters are not included.

ids={value}

(Required to update or delete record) Record IDs to update/delete. Specify record IDs and/or ID ranges (for example, 1359-1407). Multiple entries are comma separated.

title={value}

(Required to create record) A title for the record. The title must be unique. Maximum 255 characters (ascii).

comments={value}

(Optional) User defined comments. Maximum of 1999 characters.

Login Credentials

provider_name={value}

(Optional) Name of the cloud service provider. The only value supported is azure. This value will be passed by default.

login_type={basic|vault}

(Optional) The login type is basic by default. You can choose vault (for vault based authentication).

username={value}

(Required to create record, optional to update record) The username to be used for authentication to Azure MS SQL. The username must contain '@'.

password={value}

(Required to create record, optional to update record) when login_type=basic, specify the password to be used for authentication to Azure MS SQL. Maximum 100 characters (ascii).

instance_name={value}

(Optional to create or update record) The name of the database instance to be scanned. This is the instance name assigned to the TCP/IP port. Important: This is not the host name that is assigned to the Azure MS SQL Server instance name. The only value supported is MSSQLSERVER. This value will be passed by default. Currently, we do not support named instances for this parameter.

database_name={value}

(Optional to create or update record) The database name of the Azure MS SQL database to be scanned. The database name may contain a maximum of 128 characters. These parameters are mutually exclusive: database_name and auto_discover_databases=1.

auto_discover_databases= {0|1}

(Optional to create or update record) The database name of the Azure MS SQL database to be scanned. The database name may contain a maximum of 128 characters. These parameters are mutually exclusive: database_name and auto_discover_databases=1.

port={value}

(Required to create record, optional to update record) The port number assigned to the database instance to be scanned.

Vaults

vault_type={value}

(Required if login_type=vault) The third party vault to be used to retrieve the password for login. Certain vaults support this capability. View our latest Vault Support Matrix

vault_id={value}

(Required only when action=create and login_type=vault) The ID of the vault you want to use.

{vault parameters}

(Required only when action=create and login_type=vault) Vault specific parameters required depend on the vault type you've selected. See Vault Parameters.

Target Hosts

ips={value}

(Required to create record) IPs to be added to your Azure MS SQL Record record. You may enter a combination of IPs and IP ranges to identify compliance hosts. Multiple entries are comma separated.

(Optional to update record) Overwrites (replaces) the IP list for the authentication record. The IPs you specify are added and any existing IPs are removed.

add_ips={value}

(Optional and valid only to update record) Add IPs to the IPs list for this record. Multiple IPs/ranges are comma separated.

remove_ips={value}

(Optional and valid to update record) IPs to be removed from your record. You may enter a combination of IPs and ranges. Multiple entries are comma separated. This parameter and the ips parameter cannot be specified in the same request.

network_id={value}

(Optional and valid when the networks feature is enabled) The network ID for the record.