health_validations

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

Overview

Name	health_validations
Type	Resource
Id	azure.database_watcher.health_validations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
endTime	string (date-time)	The end time of health validation, in UTC. Required.
issues	array	The list of issues found by health validation. Required.
provisioningState	string	The provisioning state of the health validation resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
startTime	string (date-time)	The start time of health validation, in UTC. Required.
status	string	The current health validation status. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", "Canceled", and "TimedOut". (NotStarted, Running, Succeeded, Failed, Canceled, TimedOut)
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".

list_by_parent

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
endTime	string (date-time)	The end time of health validation, in UTC. Required.
issues	array	The list of issues found by health validation. Required.
provisioningState	string	The provisioning state of the health validation resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
startTime	string (date-time)	The start time of health validation, in UTC. Required.
status	string	The current health validation status. Required. Known values are: "NotStarted", "Running", "Succeeded", "Failed", "Canceled", and "TimedOut". (NotStarted, Running, Succeeded, Failed, Canceled, TimedOut)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, watcher_name, health_validation_name, subscription_id		Get a HealthValidation.
list_by_parent	select	resource_group_name, watcher_name, subscription_id		List HealthValidation resources by Watcher.
start_validation	exec	resource_group_name, watcher_name, health_validation_name, subscription_id		Starts health validation for a watcher.

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
health_validation_name	string	The health validation resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
watcher_name	string	The database watcher name. Required.

SELECT examples

get

Get a HealthValidation.

SELECT
id,
name,
endTime,
issues,
provisioningState,
startTime,
status,
systemData,
type
FROM azure.database_watcher.health_validations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND watcher_name = '{{ watcher_name }}' -- required
AND health_validation_name = '{{ health_validation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

List HealthValidation resources by Watcher.

SELECT
id,
name,
endTime,
issues,
provisioningState,
startTime,
status,
systemData,
type
FROM azure.database_watcher.health_validations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND watcher_name = '{{ watcher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

start_validation

Starts health validation for a watcher.

EXEC azure.database_watcher.health_validations.start_validation 
@resource_group_name='{{ resource_group_name }}' --required, 
@watcher_name='{{ watcher_name }}' --required, 
@health_validation_name='{{ health_validation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;