Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The watchers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DatabaseWatcher/watchers resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DatabaseWatcher/watchers@2025-01-02' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
datastore: {
adxClusterResourceId: 'string'
kustoClusterDisplayName: 'string'
kustoClusterUri: 'string'
kustoDatabaseName: 'string'
kustoDataIngestionUri: 'string'
kustoManagementUrl: 'string'
kustoOfferingType: 'string'
}
defaultAlertRuleIdentityResourceId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DatabaseWatcher/watchers
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ (required) |
| properties | The resource-specific properties for this resource. | WatcherProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Datastore
| Name | Description | Value |
|---|---|---|
| adxClusterResourceId | The Azure resource ID of an Azure Data Explorer cluster. | string |
| kustoClusterDisplayName | The Kusto cluster display name. | string |
| kustoClusterUri | The Kusto cluster URI. | string (required) |
| kustoDatabaseName | The name of a Kusto database. | string (required) |
| kustoDataIngestionUri | The Kusto data ingestion URI. | string (required) |
| kustoManagementUrl | The Kusto management URL. | string (required) |
| kustoOfferingType | The type of a Kusto offering. | 'adx' 'fabric' 'free' (required) |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
WatcherProperties
| Name | Description | Value |
|---|---|---|
| datastore | The data store for collected monitoring data. | Datastore |
| defaultAlertRuleIdentityResourceId | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | string |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create a database watcher | This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints |
ARM template resource definition
The watchers resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DatabaseWatcher/watchers resource, add the following JSON to your template.
{
"type": "Microsoft.DatabaseWatcher/watchers",
"apiVersion": "2025-01-02",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"datastore": {
"adxClusterResourceId": "string",
"kustoClusterDisplayName": "string",
"kustoClusterUri": "string",
"kustoDatabaseName": "string",
"kustoDataIngestionUri": "string",
"kustoManagementUrl": "string",
"kustoOfferingType": "string"
},
"defaultAlertRuleIdentityResourceId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DatabaseWatcher/watchers
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-01-02' |
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ (required) |
| properties | The resource-specific properties for this resource. | WatcherProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DatabaseWatcher/watchers' |
Datastore
| Name | Description | Value |
|---|---|---|
| adxClusterResourceId | The Azure resource ID of an Azure Data Explorer cluster. | string |
| kustoClusterDisplayName | The Kusto cluster display name. | string |
| kustoClusterUri | The Kusto cluster URI. | string (required) |
| kustoDatabaseName | The name of a Kusto database. | string (required) |
| kustoDataIngestionUri | The Kusto data ingestion URI. | string (required) |
| kustoManagementUrl | The Kusto management URL. | string (required) |
| kustoOfferingType | The type of a Kusto offering. | 'adx' 'fabric' 'free' (required) |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
WatcherProperties
| Name | Description | Value |
|---|---|---|
| datastore | The data store for collected monitoring data. | Datastore |
| defaultAlertRuleIdentityResourceId | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | string |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a database watcher |
This sample creates a database watcher for Azure SQL and configures its data store, SQL targets, and managed private endpoints |
Terraform (AzAPI provider) resource definition
The watchers resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DatabaseWatcher/watchers resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DatabaseWatcher/watchers@2025-01-02"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
datastore = {
adxClusterResourceId = "string"
kustoClusterDisplayName = "string"
kustoClusterUri = "string"
kustoDatabaseName = "string"
kustoDataIngestionUri = "string"
kustoManagementUrl = "string"
kustoOfferingType = "string"
}
defaultAlertRuleIdentityResourceId = "string"
}
}
}
Property Values
Microsoft.DatabaseWatcher/watchers
| Name | Description | Value |
|---|---|---|
| identity | The managed service identities assigned to this resource. | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$ (required) |
| properties | The resource-specific properties for this resource. | WatcherProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DatabaseWatcher/watchers@2025-01-02" |
Datastore
| Name | Description | Value |
|---|---|---|
| adxClusterResourceId | The Azure resource ID of an Azure Data Explorer cluster. | string |
| kustoClusterDisplayName | The Kusto cluster display name. | string |
| kustoClusterUri | The Kusto cluster URI. | string (required) |
| kustoDatabaseName | The name of a Kusto database. | string (required) |
| kustoDataIngestionUri | The Kusto data ingestion URI. | string (required) |
| kustoManagementUrl | The Kusto management URL. | string (required) |
| kustoOfferingType | The type of a Kusto offering. | 'adx' 'fabric' 'free' (required) |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
WatcherProperties
| Name | Description | Value |
|---|---|---|
| datastore | The data store for collected monitoring data. | Datastore |
| defaultAlertRuleIdentityResourceId | The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. | string |