Microsoft.DatabaseWatcher (preview:2023-09-01)

2025/01/10 • 13 updated methods

Watchers_ListBySubscription (updated)
Description :  List Watcher resources by subscription ID
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "datastore": [
                  {
                    "#name": "adxClusterResourceId",
                    "Description": {
                      "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                      "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DatabaseWatcher/watchers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Watcher items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Watchers_ListByResourceGroup (updated)
Description :  List Watcher resources by resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "datastore": [
                  {
                    "#name": "adxClusterResourceId",
                    "Description": {
                      "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                      "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Watcher items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Watchers_Get (updated)
Description :  Get a Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Watchers_CreateOrUpdate (updated)
Description :  Create a Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The DatabaseWatcherProviderHub resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Watchers_Update (updated)
Description :  Update a Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_Update",
  "$parameters": {
    "properties": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: False ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: False ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: False ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: False ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SharedPrivateLinkResources_ListByWatcher (updated)
Description :  List SharedPrivateLinkResource resources by Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "SharedPrivateLinkResources_ListByWatcher",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "privateLinkResourceId",
                "Description": {
                  "new": "The resource ID of the resource the shared private link resource is for.",
                  "old": "The resource id of the resource the shared private link resource is for."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SharedPrivateLinkResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Format: arm-id ,
Required: True ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: True ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: True ,
}
string ,
dnsZone:
{
Description: The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SharedPrivateLinkResources_Get (updated)
Description :  Get a SharedPrivateLinkResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "SharedPrivateLinkResources_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "privateLinkResourceId",
            "Description": {
              "new": "The resource ID of the resource the shared private link resource is for.",
              "old": "The resource id of the resource the shared private link resource is for."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The Shared Private Link resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Format: arm-id ,
Required: True ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: True ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: True ,
}
string ,
dnsZone:
{
Description: The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SharedPrivateLinkResources_Create (updated)
Description :  Create a SharedPrivateLinkResource
Reference :  Link ¶

⚶ Changes

{
  "#id": "SharedPrivateLinkResources_Create",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "privateLinkResourceId",
            "Description": {
              "new": "The resource ID of the resource the shared private link resource is for.",
              "old": "The resource id of the resource the shared private link resource is for."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "privateLinkResourceId",
            "Description": {
              "new": "The resource ID of the resource the shared private link resource is for.",
              "old": "The resource id of the resource the shared private link resource is for."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "privateLinkResourceId",
            "Description": {
              "new": "The resource ID of the resource the shared private link resource is for.",
              "old": "The resource id of the resource the shared private link resource is for."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
sharedPrivateLinkResourceName:
{
Description: The Shared Private Link resource name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Format: arm-id ,
Required: True ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: True ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: True ,
}
string ,
dnsZone:
{
Description: The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Format: arm-id ,
Required: True ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: True ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: True ,
}
string ,
dnsZone:
{
Description: The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Concrete proxy resource types can be created by aliasing this type using a specific property type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
privateLinkResourceId:
{
Description: The resource ID of the resource the shared private link resource is for. ,
Format: arm-id ,
Required: True ,
}
string ,
groupId:
{
Description: The group id from the provider of resource the shared private link resource is for. ,
Required: True ,
}
string ,
requestMessage:
{
Description: The request message for requesting approval of the shared private link resource. ,
Required: True ,
}
string ,
dnsZone:
{
Description: The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Watchers_Start (updated)
Description :  The action to start monitoring all targets configured for a database watcher.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_Start",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Watchers_Stop (updated)
Description :  The action to stop monitoring all targets configured for a database watcher.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Watchers_Stop",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "datastore": [
              {
                "#name": "adxClusterResourceId",
                "Description": {
                  "new": "The Azure resource ID of an Azure Data Explorer cluster.",
                  "old": "The Azure ResourceId of an Azure Data Explorer cluster."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
datastore:
{
Description: The data store for collected monitoring data. ,
Required: False ,
}
{
adxClusterResourceId:
{
Description: The Azure resource ID of an Azure Data Explorer cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
kustoClusterDisplayName:
{
Description: The Kusto cluster display name. ,
Required: False ,
}
string ,
kustoClusterUri:
{
Description: The Kusto cluster URI. ,
Required: True ,
}
string ,
kustoDataIngestionUri:
{
Description: The Kusto data ingestion URI. ,
Required: True ,
}
string ,
kustoDatabaseName:
{
Description: The name of a Kusto database. ,
Required: True ,
}
string ,
kustoManagementUrl:
{
Description: The Kusto management URL. ,
Required: True ,
}
string ,
kustoOfferingType:
{
Description: The type of a Kusto offering. ,
Enum:
{
adx: The Azure Data Explorer cluster Kusto offering. ,
free: The free Azure Data Explorer cluster Kusto offering. ,
fabric: The Fabric Real-Time Analytics Kusto offering. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The monitoring collection status of the watcher. ,
Enum:
{
Starting: Denotes the watcher is in a starting state. ,
Running: Denotes the watcher is in a running state. ,
Stopping: Denotes the watcher is in a stopping state. ,
Stopped: Denotes the watcher is in a stopped state. ,
Deleting: Denotes the watcher is in a deleting state. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource watcher. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_ListByWatcher (updated)
Description :  List Target resources by Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_ListByWatcher",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "targetVault": [
                  {
                    "#name": "akvResourceId",
                    "Description": {
                      "new": "The Azure resource ID of the Key Vault instance storing database authentication secrets.",
                      "old": "The Azure ResourceId of the Key Vault instance storing database authentication secrets."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Target items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
targetType:
{
Description: Discriminator property for TargetProperties. ,
Required: True ,
}
string ,
targetAuthenticationType:
{
Description: The type of authentication to use when connecting to a target. ,
Enum:
{
Aad: The Azure Active Directory authentication. ,
Sql: The SQL password authentication. ,
}
,
Required: True ,
}
enum ,
targetVault:
{
Description: To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. ,
Required: False ,
}
{
akvResourceId:
{
Description: The Azure resource ID of the Key Vault instance storing database authentication secrets. ,
Format: arm-id ,
Required: False ,
}
string ,
akvTargetUser:
{
Description: The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. ,
Required: False ,
}
string ,
akvTargetPassword:
{
Description: The path to the Key Vault secret storing the password for authentication to a target. ,
Required: False ,
}
string ,
}
,
connectionServerName:
{
Description: The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_Get (updated)
Description :  Get a Target
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "targetVault": [
              {
                "#name": "akvResourceId",
                "Description": {
                  "new": "The Azure resource ID of the Key Vault instance storing database authentication secrets.",
                  "old": "The Azure ResourceId of the Key Vault instance storing database authentication secrets."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
targetName:
{
Description: The target resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
targetType:
{
Description: Discriminator property for TargetProperties. ,
Required: True ,
}
string ,
targetAuthenticationType:
{
Description: The type of authentication to use when connecting to a target. ,
Enum:
{
Aad: The Azure Active Directory authentication. ,
Sql: The SQL password authentication. ,
}
,
Required: True ,
}
enum ,
targetVault:
{
Description: To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. ,
Required: False ,
}
{
akvResourceId:
{
Description: The Azure resource ID of the Key Vault instance storing database authentication secrets. ,
Format: arm-id ,
Required: False ,
}
string ,
akvTargetUser:
{
Description: The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. ,
Required: False ,
}
string ,
akvTargetPassword:
{
Description: The path to the Key Vault secret storing the password for authentication to a target. ,
Required: False ,
}
string ,
}
,
connectionServerName:
{
Description: The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Targets_CreateOrUpdate (updated)
Description :  Create a Target
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "targetVault": [
              {
                "#name": "akvResourceId",
                "Description": {
                  "new": "The Azure resource ID of the Key Vault instance storing database authentication secrets.",
                  "old": "The Azure ResourceId of the Key Vault instance storing database authentication secrets."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "targetVault": [
              {
                "#name": "akvResourceId",
                "Description": {
                  "new": "The Azure resource ID of the Key Vault instance storing database authentication secrets.",
                  "old": "The Azure ResourceId of the Key Vault instance storing database authentication secrets."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "targetVault": [
              {
                "#name": "akvResourceId",
                "Description": {
                  "new": "The Azure resource ID of the Key Vault instance storing database authentication secrets.",
                  "old": "The Azure ResourceId of the Key Vault instance storing database authentication secrets."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
watcherName:
{
Description: The database watcher name. ,
Required: True ,
}
string ,
targetName:
{
Description: The target resource name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
targetType:
{
Description: Discriminator property for TargetProperties. ,
Required: True ,
}
string ,
targetAuthenticationType:
{
Description: The type of authentication to use when connecting to a target. ,
Enum:
{
Aad: The Azure Active Directory authentication. ,
Sql: The SQL password authentication. ,
}
,
Required: True ,
}
enum ,
targetVault:
{
Description: To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. ,
Required: False ,
}
{
akvResourceId:
{
Description: The Azure resource ID of the Key Vault instance storing database authentication secrets. ,
Format: arm-id ,
Required: False ,
}
string ,
akvTargetUser:
{
Description: The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. ,
Required: False ,
}
string ,
akvTargetPassword:
{
Description: The path to the Key Vault secret storing the password for authentication to a target. ,
Required: False ,
}
string ,
}
,
connectionServerName:
{
Description: The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
targetType:
{
Description: Discriminator property for TargetProperties. ,
Required: True ,
}
string ,
targetAuthenticationType:
{
Description: The type of authentication to use when connecting to a target. ,
Enum:
{
Aad: The Azure Active Directory authentication. ,
Sql: The SQL password authentication. ,
}
,
Required: True ,
}
enum ,
targetVault:
{
Description: To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. ,
Required: False ,
}
{
akvResourceId:
{
Description: The Azure resource ID of the Key Vault instance storing database authentication secrets. ,
Format: arm-id ,
Required: False ,
}
string ,
akvTargetUser:
{
Description: The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. ,
Required: False ,
}
string ,
akvTargetPassword:
{
Description: The path to the Key Vault secret storing the password for authentication to a target. ,
Required: False ,
}
string ,
}
,
connectionServerName:
{
Description: The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
targetType:
{
Description: Discriminator property for TargetProperties. ,
Required: True ,
}
string ,
targetAuthenticationType:
{
Description: The type of authentication to use when connecting to a target. ,
Enum:
{
Aad: The Azure Active Directory authentication. ,
Sql: The SQL password authentication. ,
}
,
Required: True ,
}
enum ,
targetVault:
{
Description: To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. ,
Required: False ,
}
{
akvResourceId:
{
Description: The Azure resource ID of the Key Vault instance storing database authentication secrets. ,
Format: arm-id ,
Required: False ,
}
string ,
akvTargetUser:
{
Description: The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. ,
Required: False ,
}
string ,
akvTargetPassword:
{
Description: The path to the Key Vault secret storing the password for authentication to a target. ,
Required: False ,
}
string ,
}
,
connectionServerName:
{
Description: The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}