diagnostic_settings

Creates, updates, deletes, gets or lists a diagnostic_settings resource.

Overview

Name	diagnostic_settings
Type	Resource
Id	azure.data_box_edge.diagnostic_settings

Fields

The following fields are returned by SELECT queries:

get_diagnostic_proactive_log_collection_settings

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userConsent	string	Proactive diagnostic collection consent flag. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_diagnostic_proactive_log_collection_settings	select	device_name, resource_group_name, subscription_id		Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.
update_diagnostic_proactive_log_collection_settings	exec	device_name, resource_group_name, subscription_id, properties		Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.
get_diagnostic_remote_support_settings	exec	device_name, resource_group_name, subscription_id		Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.
update_diagnostic_remote_support_settings	exec	device_name, resource_group_name, subscription_id, properties		Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
device_name	string	The device name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get_diagnostic_proactive_log_collection_settings

Gets the proactive log collection settings of the specified Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
systemData,
type,
userConsent
FROM azure.data_box_edge.diagnostic_settings
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

update_diagnostic_proactive_log_collection_settings

Updates the proactive log collection settings on a Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.diagnostic_settings.update_diagnostic_proactive_log_collection_settings 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

get_diagnostic_remote_support_settings

Gets the diagnostic remote support settings of the specified Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.diagnostic_settings.get_diagnostic_remote_support_settings 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_diagnostic_remote_support_settings

Updates the diagnostic remote support settings on a Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.diagnostic_settings.update_diagnostic_remote_support_settings 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;