watchers

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

Overview

Name	watchers
Type	Resource
Id	azure.database_watcher.watchers

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.
datastore	object	The data store for collected monitoring data.
defaultAlertRuleIdentityResourceId	string	The resource ID of a user-assigned managed identity that will be assigned to a new alert rule.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the resource watcher. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The monitoring collection status of the watcher. Known values are: "Starting", "Running", "Stopping", "Stopped", and "Deleting". (Starting, Running, Stopping, Stopped, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
datastore	object	The data store for collected monitoring data.
defaultAlertRuleIdentityResourceId	string	The resource ID of a user-assigned managed identity that will be assigned to a new alert rule.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the resource watcher. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The monitoring collection status of the watcher. Known values are: "Starting", "Running", "Stopping", "Stopped", and "Deleting". (Starting, Running, Stopping, Stopped, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
datastore	object	The data store for collected monitoring data.
defaultAlertRuleIdentityResourceId	string	The resource ID of a user-assigned managed identity that will be assigned to a new alert rule.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the resource watcher. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
status	string	The monitoring collection status of the watcher. Known values are: "Starting", "Running", "Stopping", "Stopped", and "Deleting". (Starting, Running, Stopping, Stopped, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id		Get a Watcher.
list_by_resource_group	select	resource_group_name, subscription_id		List Watcher resources by resource group.
list_by_subscription	select	subscription_id		List Watcher resources by subscription ID.
create_or_update	insert	resource_group_name, watcher_name, subscription_id, location		Create a Watcher.
update	update	resource_group_name, watcher_name, subscription_id		Update a Watcher.
create_or_update	replace	resource_group_name, watcher_name, subscription_id, location		Create a Watcher.
delete	delete	resource_group_name, watcher_name, subscription_id		Delete a Watcher.
start	exec	resource_group_name, watcher_name, subscription_id		The action to start monitoring all targets configured for a database watcher.
stop	exec	resource_group_name, watcher_name, subscription_id		The action to stop monitoring all targets configured for a database 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
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 Watcher.

SELECT
id,
name,
datastore,
defaultAlertRuleIdentityResourceId,
identity,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.database_watcher.watchers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND watcher_name = '{{ watcher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Watcher resources by resource group.

SELECT
id,
name,
datastore,
defaultAlertRuleIdentityResourceId,
identity,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.database_watcher.watchers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Watcher resources by subscription ID.

SELECT
id,
name,
datastore,
defaultAlertRuleIdentityResourceId,
identity,
location,
provisioningState,
status,
systemData,
tags,
type
FROM azure.database_watcher.watchers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Watcher.

INSERT INTO azure.database_watcher.watchers (
tags,
location,
properties,
identity,
resource_group_name,
watcher_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ watcher_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: watchers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the watchers resource.
  - name: watcher_name
    value: "{{ watcher_name }}"
    description: Required parameter for the watchers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the watchers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      datastore:
        adxClusterResourceId: "{{ adxClusterResourceId }}"
        kustoClusterDisplayName: "{{ kustoClusterDisplayName }}"
        kustoClusterUri: "{{ kustoClusterUri }}"
        kustoDataIngestionUri: "{{ kustoDataIngestionUri }}"
        kustoDatabaseName: "{{ kustoDatabaseName }}"
        kustoManagementUrl: "{{ kustoManagementUrl }}"
        kustoOfferingType: "{{ kustoOfferingType }}"
      status: "{{ status }}"
      provisioningState: "{{ provisioningState }}"
      defaultAlertRuleIdentityResourceId: "{{ defaultAlertRuleIdentityResourceId }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a Watcher.

UPDATE azure.database_watcher.watchers
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND watcher_name = '{{ watcher_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a Watcher.

REPLACE azure.database_watcher.watchers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND watcher_name = '{{ watcher_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Watcher.

DELETE FROM azure.database_watcher.watchers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND watcher_name = '{{ watcher_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

start

The action to start monitoring all targets configured for a database watcher.

EXEC azure.database_watcher.watchers.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@watcher_name='{{ watcher_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

stop

The action to stop monitoring all targets configured for a database watcher.

EXEC azure.database_watcher.watchers.stop 
@resource_group_name='{{ resource_group_name }}' --required, 
@watcher_name='{{ watcher_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;