Microsoft.DatabaseWatcher (stable:2025-01-02)

2025/01/10 • 24 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DatabaseWatcher/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
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_ListBySubscription (new)
Description :  List Watcher resources by subscription ID
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 (new)
Description :  List Watcher resources by resource group
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 (new)
Description :  Get a Watcher
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 (new)
Description :  Create a Watcher
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 (new)
Description :  Update a Watcher
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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_Delete (new)
Description :  Delete a Watcher
Reference :  Link ¶

⚼ Request

DELETE:  /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. The value must be an UUID. ,
Format: uuid ,
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 (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 (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
AlertRuleResources_ListByParent (new)
Description :  List AlertRuleResource resources by Watcher
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/alertRuleResources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 AlertRuleResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
alertRuleResourceId:
{
Description: The resource ID of the alert rule resource. ,
Format: arm-id ,
Required: True ,
}
string ,
createdWithProperties:
{
Description: The properties with which the alert rule resource was created. ,
Enum:
{
CreatedWithActionGroup: The alert rule was created with an action group. ,
None: The alert rule was created with no properties. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The creation time of the alert rule resource. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the alert rule resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
alertRuleTemplateId:
{
Description: The template ID associated with alert rule resource. ,
Required: True ,
}
string ,
alertRuleTemplateVersion:
{
Description: The alert rule template version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
AlertRuleResources_Get (new)
Description :  Get a AlertRuleResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/alertRuleResources/{alertRuleResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
alertRuleResourceName:
{
Description: The alert rule proxy resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
alertRuleResourceId:
{
Description: The resource ID of the alert rule resource. ,
Format: arm-id ,
Required: True ,
}
string ,
createdWithProperties:
{
Description: The properties with which the alert rule resource was created. ,
Enum:
{
CreatedWithActionGroup: The alert rule was created with an action group. ,
None: The alert rule was created with no properties. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The creation time of the alert rule resource. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the alert rule resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
alertRuleTemplateId:
{
Description: The template ID associated with alert rule resource. ,
Required: True ,
}
string ,
alertRuleTemplateVersion:
{
Description: The alert rule template version. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
AlertRuleResources_CreateOrUpdate (new)
Description :  Create a AlertRuleResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/alertRuleResources/{alertRuleResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
alertRuleResourceName:
{
Description: The alert rule proxy resource name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
alertRuleResourceId:
{
Description: The resource ID of the alert rule resource. ,
Format: arm-id ,
Required: True ,
}
string ,
createdWithProperties:
{
Description: The properties with which the alert rule resource was created. ,
Enum:
{
CreatedWithActionGroup: The alert rule was created with an action group. ,
None: The alert rule was created with no properties. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The creation time of the alert rule resource. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the alert rule resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
alertRuleTemplateId:
{
Description: The template ID associated with alert rule resource. ,
Required: True ,
}
string ,
alertRuleTemplateVersion:
{
Description: The alert rule template version. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
alertRuleResourceId:
{
Description: The resource ID of the alert rule resource. ,
Format: arm-id ,
Required: True ,
}
string ,
createdWithProperties:
{
Description: The properties with which the alert rule resource was created. ,
Enum:
{
CreatedWithActionGroup: The alert rule was created with an action group. ,
None: The alert rule was created with no properties. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The creation time of the alert rule resource. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the alert rule resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
alertRuleTemplateId:
{
Description: The template ID associated with alert rule resource. ,
Required: True ,
}
string ,
alertRuleTemplateVersion:
{
Description: The alert rule template version. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
alertRuleResourceId:
{
Description: The resource ID of the alert rule resource. ,
Format: arm-id ,
Required: True ,
}
string ,
createdWithProperties:
{
Description: The properties with which the alert rule resource was created. ,
Enum:
{
CreatedWithActionGroup: The alert rule was created with an action group. ,
None: The alert rule was created with no properties. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The creation time of the alert rule resource. ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the alert rule resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
alertRuleTemplateId:
{
Description: The template ID associated with alert rule resource. ,
Required: True ,
}
string ,
alertRuleTemplateVersion:
{
Description: The alert rule template version. ,
Required: True ,
}
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 ,
}
,
]
,
}
,
}
AlertRuleResources_Delete (new)
Description :  Delete a AlertRuleResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/alertRuleResources/{alertRuleResourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
alertRuleResourceName:
{
Description: The alert rule proxy resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
HealthValidations_ListByParent (new)
Description :  List HealthValidation resources by Watcher
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/healthValidations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 HealthValidation items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
startTime:
{
Description: The start time of health validation, in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The end time of health validation, in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The current health validation status. ,
Enum:
{
NotStarted: Health validation has not started. ,
Running: Health validation is running. ,
Succeeded: Health validation completed successfully. ,
Failed: Health validation failed. ,
Canceled: Health validation was canceled. ,
TimedOut: Health validation timed out. ,
}
,
Required: True ,
}
enum ,
issues:
{
Description: The list of issues found by health validation. ,
Required: True ,
}
[
{
errorCode:
{
Description: The error code of the issue. ,
Required: True ,
}
string ,
errorMessage:
{
Description: The error message of the issue. ,
Required: True ,
}
string ,
additionalDetails:
{
Description: The additional details for the issue. ,
Required: False ,
}
string ,
recommendationMessage:
{
Description: The recommendation for resolving the issue. ,
Required: True ,
}
string ,
recommendationUrl:
{
Description: The URL related to resolving the issue. ,
Format: uri ,
Required: False ,
}
string ,
relatedResourceId:
{
Description: The resource ID of the Azure resource related to the issue. ,
Format: arm-id ,
Required: False ,
}
string ,
relatedResourceType:
{
Description: The type of the Azure resource related to the issue. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the health validation 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 ,
}
,
]
,
}
,
}
HealthValidations_Get (new)
Description :  Get a HealthValidation
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/healthValidations/{healthValidationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
healthValidationName:
{
Description: The health validation resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
startTime:
{
Description: The start time of health validation, in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The end time of health validation, in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The current health validation status. ,
Enum:
{
NotStarted: Health validation has not started. ,
Running: Health validation is running. ,
Succeeded: Health validation completed successfully. ,
Failed: Health validation failed. ,
Canceled: Health validation was canceled. ,
TimedOut: Health validation timed out. ,
}
,
Required: True ,
}
enum ,
issues:
{
Description: The list of issues found by health validation. ,
Required: True ,
}
[
{
errorCode:
{
Description: The error code of the issue. ,
Required: True ,
}
string ,
errorMessage:
{
Description: The error message of the issue. ,
Required: True ,
}
string ,
additionalDetails:
{
Description: The additional details for the issue. ,
Required: False ,
}
string ,
recommendationMessage:
{
Description: The recommendation for resolving the issue. ,
Required: True ,
}
string ,
recommendationUrl:
{
Description: The URL related to resolving the issue. ,
Format: uri ,
Required: False ,
}
string ,
relatedResourceId:
{
Description: The resource ID of the Azure resource related to the issue. ,
Format: arm-id ,
Required: False ,
}
string ,
relatedResourceType:
{
Description: The type of the Azure resource related to the issue. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the health validation 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 ,
}
,
]
,
}
,
}
HealthValidations_StartValidation (new)
Description :  Starts health validation for a watcher.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/healthValidations/{healthValidationName}/startValidation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
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 ,
healthValidationName:
{
Description: The health validation resource name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
startTime:
{
Description: The start time of health validation, in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: The end time of health validation, in UTC. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The current health validation status. ,
Enum:
{
NotStarted: Health validation has not started. ,
Running: Health validation is running. ,
Succeeded: Health validation completed successfully. ,
Failed: Health validation failed. ,
Canceled: Health validation was canceled. ,
TimedOut: Health validation timed out. ,
}
,
Required: True ,
}
enum ,
issues:
{
Description: The list of issues found by health validation. ,
Required: True ,
}
[
{
errorCode:
{
Description: The error code of the issue. ,
Required: True ,
}
string ,
errorMessage:
{
Description: The error message of the issue. ,
Required: True ,
}
string ,
additionalDetails:
{
Description: The additional details for the issue. ,
Required: False ,
}
string ,
recommendationMessage:
{
Description: The recommendation for resolving the issue. ,
Required: True ,
}
string ,
recommendationUrl:
{
Description: The URL related to resolving the issue. ,
Format: uri ,
Required: False ,
}
string ,
relatedResourceId:
{
Description: The resource ID of the Azure resource related to the issue. ,
Format: arm-id ,
Required: False ,
}
string ,
relatedResourceType:
{
Description: The type of the Azure resource related to the issue. ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the health validation resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 (new)
Description :  List SharedPrivateLinkResource resources by Watcher
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 (new)
Description :  Get a SharedPrivateLinkResource
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 (new)
Description :  Create a SharedPrivateLinkResource
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
,
]
,
}
,
}
SharedPrivateLinkResources_Delete (new)
Description :  Delete a SharedPrivateLinkResource
Reference :  Link ¶

⚼ Request

DELETE:  /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. The value must be an UUID. ,
Format: uuid ,
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 (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 (204)

{}

⚐ 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 (new)
Description :  The action to start monitoring all targets configured for a database watcher.
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 (new)
Description :  The action to stop monitoring all targets configured for a database watcher.
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
defaultAlertRuleIdentityResourceId:
{
Description: The resource ID of a user-assigned managed identity that will be assigned to a new alert rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
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 (new)
Description :  List Target resources by Watcher
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 (new)
Description :  Get a Target
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 (new)
Description :  Create a Target
Reference :  Link ¶

⚼ 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. The value must be an UUID. ,
Format: uuid ,
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 ,
}
,
]
,
}
,
}
Targets_Delete (new)
Description :  Delete a Target
Reference :  Link ¶

⚼ Request

DELETE:  /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. The value must be an UUID. ,
Format: uuid ,
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)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}