{ "swagger": "2.0", "info": { "title": "Microsoft.DatabaseWatcher", "version": "2023-09-01-preview", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Operations" }, { "name": "Watchers" }, { "name": "Targets" }, { "name": "SharedPrivateLinkResources" } ], "paths": { "/providers/Microsoft.DatabaseWatcher/operations": { "get": { "operationId": "Operations_List", "tags": [ "Operations" ], "description": "List the operations for the provider", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Operations_List": { "$ref": "./examples/Operations_List_200.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DatabaseWatcher/watchers": { "get": { "operationId": "Watchers_ListBySubscription", "tags": [ "Watchers" ], "description": "List Watcher resources by subscription ID", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WatcherListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_ListBySubscription": { "$ref": "./examples/Watchers_ListBySubscription_200.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers": { "get": { "operationId": "Watchers_ListByResourceGroup", "tags": [ "Watchers" ], "description": "List Watcher resources by resource group", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WatcherListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_ListByResourceGroup": { "$ref": "./examples/Watchers_ListByResourceGroup_200.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}": { "get": { "operationId": "Watchers_Get", "tags": [ "Watchers" ], "description": "Get a Watcher", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Watcher" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_Get": { "$ref": "./examples/Watchers_Get_200.json" } } }, "put": { "operationId": "Watchers_CreateOrUpdate", "tags": [ "Watchers" ], "description": "Create a Watcher", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Watcher" } } ], "responses": { "200": { "description": "Resource 'Watcher' update operation succeeded", "schema": { "$ref": "#/definitions/Watcher" } }, "201": { "description": "Resource 'Watcher' create operation succeeded", "schema": { "$ref": "#/definitions/Watcher" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_CreateOrUpdate": { "$ref": "./examples/Watchers_CreateOrUpdate_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "Watchers_Update", "tags": [ "Watchers" ], "description": "Update a Watcher", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/WatcherUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Watcher" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_Update": { "$ref": "./examples/Watchers_Update_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Watchers_Delete", "tags": [ "Watchers" ], "description": "Delete a Watcher", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_Delete": { "$ref": "./examples/Watchers_Delete_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources": { "get": { "operationId": "SharedPrivateLinkResources_ListByWatcher", "tags": [ "SharedPrivateLinkResources" ], "description": "List SharedPrivateLinkResource resources by Watcher", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedPrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SharedPrivateLinkResources_ListByWatcher": { "$ref": "./examples/SharedPrivateLinkResources_ListByWatcher_200.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName}": { "get": { "operationId": "SharedPrivateLinkResources_Get", "tags": [ "SharedPrivateLinkResources" ], "description": "Get a SharedPrivateLinkResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "sharedPrivateLinkResourceName", "in": "path", "description": "The Shared Private Link resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9_]{1}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SharedPrivateLinkResources_Get": { "$ref": "./examples/SharedPrivateLinkResources_Get_200.json" } } }, "put": { "operationId": "SharedPrivateLinkResources_Create", "tags": [ "SharedPrivateLinkResources" ], "description": "Create a SharedPrivateLinkResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "sharedPrivateLinkResourceName", "in": "path", "description": "The Shared Private Link resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9_]{1}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } } ], "responses": { "200": { "description": "Resource 'SharedPrivateLinkResource' update operation succeeded", "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" } }, "201": { "description": "Resource 'SharedPrivateLinkResource' create operation succeeded", "schema": { "$ref": "#/definitions/SharedPrivateLinkResource" }, "headers": { "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SharedPrivateLinkResources_Create": { "$ref": "./examples/SharedPrivateLinkResources_Create_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "SharedPrivateLinkResources_Delete", "tags": [ "SharedPrivateLinkResources" ], "description": "Delete a SharedPrivateLinkResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "sharedPrivateLinkResourceName", "in": "path", "description": "The Shared Private Link resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_.]{0,62}[a-zA-Z0-9_]{1}$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "SharedPrivateLinkResources_Delete": { "$ref": "./examples/SharedPrivateLinkResources_Delete_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/start": { "post": { "operationId": "Watchers_Start", "tags": [ "Watchers" ], "description": "The action to start monitoring all targets configured for a database watcher.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Watcher" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_Start": { "$ref": "./examples/Watchers_Start_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/stop": { "post": { "operationId": "Watchers_Stop", "tags": [ "Watchers" ], "description": "The action to stop monitoring all targets configured for a database watcher.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Watcher" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Watchers_Stop": { "$ref": "./examples/Watchers_Stop_200.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets": { "get": { "operationId": "Targets_ListByWatcher", "tags": [ "Targets" ], "description": "List Target resources by Watcher", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/TargetListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Targets_ListByWatcher": { "$ref": "./examples/Targets_ListByWatcher_200.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName}": { "get": { "operationId": "Targets_Get", "tags": [ "Targets" ], "description": "Get a Target", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "targetName", "in": "path", "description": "The target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Target" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Targets_Get": { "$ref": "./examples/Targets_Get_200.json" } } }, "put": { "operationId": "Targets_CreateOrUpdate", "tags": [ "Targets" ], "description": "Create a Target", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "targetName", "in": "path", "description": "The target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/Target" } } ], "responses": { "200": { "description": "Resource 'Target' update operation succeeded", "schema": { "$ref": "#/definitions/Target" } }, "201": { "description": "Resource 'Target' create operation succeeded", "schema": { "$ref": "#/definitions/Target" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Targets_CreateOrUpdate": { "$ref": "./examples/Targets_CreateOrUpdate_200.json" } } }, "delete": { "operationId": "Targets_Delete", "tags": [ "Targets" ], "description": "Delete a Target", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "watcherName", "in": "path", "description": "The database watcher name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" }, { "name": "targetName", "in": "path", "description": "The target resource name.", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Targets_Delete": { "$ref": "./examples/Targets_Delete_200.json" } } } } }, "definitions": { "Azure.ResourceManager.ResourceProvisioningState": { "type": "string", "description": "The provisioning state of a resource type.", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "ResourceProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." } ] }, "readOnly": true }, "DatabaseWatcherProvisioningState": { "type": "string", "description": "The status of the last provisioning operation performed on the resource.", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "DatabaseWatcherProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." } ] }, "readOnly": true }, "Datastore": { "type": "object", "description": "The properties of a data store.", "properties": { "adxClusterResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of an Azure Data Explorer cluster.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Kusto/clusters" } ] } }, "kustoClusterDisplayName": { "type": "string", "description": "The Kusto cluster display name." }, "kustoClusterUri": { "type": "string", "description": "The Kusto cluster URI." }, "kustoDataIngestionUri": { "type": "string", "description": "The Kusto data ingestion URI." }, "kustoDatabaseName": { "type": "string", "description": "The name of a Kusto database." }, "kustoManagementUrl": { "type": "string", "description": "The Kusto management URL." }, "kustoOfferingType": { "$ref": "#/definitions/KustoOfferingType", "description": "The type of a Kusto offering." } }, "required": [ "kustoClusterUri", "kustoDataIngestionUri", "kustoDatabaseName", "kustoManagementUrl", "kustoOfferingType" ] }, "DatastoreUpdate": { "type": "object", "description": "The properties of a data store.", "properties": { "adxClusterResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of an Azure Data Explorer cluster.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Kusto/clusters" } ] } }, "kustoClusterDisplayName": { "type": "string", "description": "The Kusto cluster display name." }, "kustoClusterUri": { "type": "string", "description": "The Kusto cluster URI." }, "kustoDataIngestionUri": { "type": "string", "description": "The Kusto data ingestion URI." }, "kustoDatabaseName": { "type": "string", "description": "The name of a Kusto database." }, "kustoManagementUrl": { "type": "string", "description": "The Kusto management URL." }, "kustoOfferingType": { "$ref": "#/definitions/KustoOfferingType", "description": "The type of a Kusto offering." } } }, "KustoOfferingType": { "type": "string", "description": "The type of Kusto offering.", "enum": [ "adx", "free", "fabric" ], "x-ms-enum": { "name": "KustoOfferingType", "modelAsString": true, "values": [ { "name": "adx", "value": "adx", "description": "The Azure Data Explorer cluster Kusto offering." }, { "name": "free", "value": "free", "description": "The free Azure Data Explorer cluster Kusto offering." }, { "name": "fabric", "value": "fabric", "description": "The Fabric Real-Time Analytics Kusto offering." } ] } }, "SharedPrivateLinkResource": { "type": "object", "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/SharedPrivateLinkResourceProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "SharedPrivateLinkResourceListResult": { "type": "object", "description": "The response of a SharedPrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The SharedPrivateLinkResource items on this page", "items": { "$ref": "#/definitions/SharedPrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "SharedPrivateLinkResourceProperties": { "type": "object", "description": "The generic properties of a Shared Private Link resource.", "properties": { "privateLinkResourceId": { "type": "string", "format": "arm-id", "description": "The resource id of the resource the shared private link resource is for." }, "groupId": { "type": "string", "description": "The group id from the provider of resource the shared private link resource is for." }, "requestMessage": { "type": "string", "description": "The request message for requesting approval of the shared private link resource." }, "dnsZone": { "type": "string", "description": "The DNS zone to be included in the DNS name of the shared private link. Value is service-specific." }, "status": { "$ref": "#/definitions/SharedPrivateLinkResourceStatus", "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The provisioning state of the resource.", "readOnly": true } }, "required": [ "privateLinkResourceId", "groupId", "requestMessage" ] }, "SharedPrivateLinkResourceStatus": { "type": "string", "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.", "enum": [ "Pending", "Approved", "Rejected", "Disconnected" ], "x-ms-enum": { "name": "SharedPrivateLinkResourceStatus", "modelAsString": true, "values": [ { "name": "Pending", "value": "Pending", "description": "The shared private link connection request was not yet authorized by the resource owner." }, { "name": "Approved", "value": "Approved", "description": "The shared private link connection request was approved by the resource owner." }, { "name": "Rejected", "value": "Rejected", "description": "The shared private link connection request was rejected by the resource owner." }, { "name": "Disconnected", "value": "Disconnected", "description": "The shared private link connection request was disconnected by the resource owner." } ] } }, "SqlDbElasticPoolTargetProperties": { "type": "object", "description": "The properties specific to elastic pool in Azure SQL Database.", "properties": { "sqlEpResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of an Azure SQL DB elastic pool target.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Sql/servers/elasticPools" } ] } }, "anchorDatabaseResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of the anchor database used to connect to an elastic pool.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Sql/servers/databases" } ] } }, "readIntent": { "type": "boolean", "description": "Set to true to monitor a high availability replica of specified target, if any.", "default": false } }, "required": [ "sqlEpResourceId", "anchorDatabaseResourceId" ], "allOf": [ { "$ref": "#/definitions/TargetProperties" } ], "x-ms-discriminator-value": "SqlEp" }, "SqlDbSingleDatabaseTargetProperties": { "type": "object", "description": "The properties specific to single database in Azure SQL Database.", "properties": { "sqlDbResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of an Azure SQL DB single database target.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Sql/servers/databases" } ] } }, "readIntent": { "type": "boolean", "description": "Set to true to monitor a high availability replica of specified target, if any.", "default": false } }, "required": [ "sqlDbResourceId" ], "allOf": [ { "$ref": "#/definitions/TargetProperties" } ], "x-ms-discriminator-value": "SqlDb" }, "SqlMiTargetProperties": { "type": "object", "description": "The properties specific to Azure SQL Managed Instance targets.", "properties": { "sqlMiResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of an Azure SQL Managed Instance target.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Sql/managedInstances" } ] } }, "connectionTcpPort": { "type": "integer", "format": "int32", "description": "The TCP port number to optionally use in the connection string when connecting to an Azure SQL Managed Instance target.", "default": 1433 }, "readIntent": { "type": "boolean", "description": "Set to true to monitor a high availability replica of specified target, if any.", "default": false } }, "required": [ "sqlMiResourceId" ], "allOf": [ { "$ref": "#/definitions/TargetProperties" } ], "x-ms-discriminator-value": "SqlMi" }, "SqlVmTargetProperties": { "type": "object", "description": "The properties specific to Azure SQL VM targets.", "properties": { "sqlVmResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of an Azure SQL VM target.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" } ] } }, "connectionTcpPort": { "type": "integer", "format": "int32", "description": "The TCP port number to optionally use in the connection string when connecting to an Azure SQL VM target.", "default": 1433 }, "sqlNamedInstanceName": { "type": "string", "description": "The SQL instance name to optionally use in the connection string when connecting to an Azure SQL VM target." } }, "required": [ "sqlVmResourceId" ], "allOf": [ { "$ref": "#/definitions/TargetProperties" } ], "x-ms-discriminator-value": "SqlVm" }, "Target": { "type": "object", "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", "properties": { "properties": { "$ref": "#/definitions/TargetProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "TargetAuthenticationType": { "type": "string", "description": "The type of authentication to use when connecting to a target.", "enum": [ "Aad", "Sql" ], "x-ms-enum": { "name": "TargetAuthenticationType", "modelAsString": true, "values": [ { "name": "Aad", "value": "Aad", "description": "The Azure Active Directory authentication." }, { "name": "Sql", "value": "Sql", "description": "The SQL password authentication." } ] } }, "TargetListResult": { "type": "object", "description": "The response of a Target list operation.", "properties": { "value": { "type": "array", "description": "The Target items on this page", "items": { "$ref": "#/definitions/Target" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "TargetProperties": { "type": "object", "description": "The generic properties of a target.", "properties": { "targetType": { "type": "string", "description": "Discriminator property for TargetProperties." }, "targetAuthenticationType": { "$ref": "#/definitions/TargetAuthenticationType", "description": "The type of authentication to use when connecting to a target." }, "targetVault": { "$ref": "#/definitions/VaultSecret", "description": "To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored." }, "connectionServerName": { "type": "string", "description": "The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately.", "maxLength": 200 }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "The provisioning state of the resource.", "readOnly": true } }, "discriminator": "targetType", "required": [ "targetType", "targetAuthenticationType", "connectionServerName" ] }, "VaultSecret": { "type": "object", "description": "The vault specific details required if using SQL authentication to connect to a target.", "properties": { "akvResourceId": { "type": "string", "format": "arm-id", "description": "The Azure ResourceId of the Key Vault instance storing database authentication secrets.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.KeyVault/vaults" } ] } }, "akvTargetUser": { "type": "string", "description": "The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.", "pattern": "^[a-zA-Z0-9-]{1,127}$" }, "akvTargetPassword": { "type": "string", "description": "The path to the Key Vault secret storing the password for authentication to a target.", "pattern": "^[a-zA-Z0-9-]{1,127}$" } } }, "Watcher": { "type": "object", "description": "The DatabaseWatcherProviderHub resource.", "properties": { "properties": { "$ref": "#/definitions/WatcherProperties", "description": "The resource-specific properties for this resource.", "x-ms-client-flatten": true }, "identity": { "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" } ] }, "WatcherListResult": { "type": "object", "description": "The response of a Watcher list operation.", "properties": { "value": { "type": "array", "description": "The Watcher items on this page", "items": { "$ref": "#/definitions/Watcher" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "WatcherProperties": { "type": "object", "description": "The RP specific properties of the resource.", "properties": { "datastore": { "$ref": "#/definitions/Datastore", "description": "The data store for collected monitoring data." }, "status": { "$ref": "#/definitions/WatcherStatus", "description": "The monitoring collection status of the watcher.", "readOnly": true }, "provisioningState": { "$ref": "#/definitions/DatabaseWatcherProvisioningState", "description": "The provisioning state of the resource watcher.", "readOnly": true } } }, "WatcherStatus": { "type": "string", "description": "The monitoring collection status of a watcher.", "enum": [ "Starting", "Running", "Stopping", "Stopped", "Deleting" ], "x-ms-enum": { "name": "WatcherStatus", "modelAsString": true, "values": [ { "name": "Starting", "value": "Starting", "description": "Denotes the watcher is in a starting state." }, { "name": "Running", "value": "Running", "description": "Denotes the watcher is in a running state." }, { "name": "Stopping", "value": "Stopping", "description": "Denotes the watcher is in a stopping state." }, { "name": "Stopped", "value": "Stopped", "description": "Denotes the watcher is in a stopped state." }, { "name": "Deleting", "value": "Deleting", "description": "Denotes the watcher is in a deleting state." } ] } }, "WatcherUpdate": { "type": "object", "description": "The type used for update operations of the Watcher.", "properties": { "identity": { "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } }, "properties": { "$ref": "#/definitions/WatcherUpdateProperties", "x-ms-client-flatten": true } } }, "WatcherUpdateProperties": { "type": "object", "description": "The updatable properties of the Watcher.", "properties": { "datastore": { "$ref": "#/definitions/DatastoreUpdate", "description": "The data store for collected monitoring data." } } } }, "parameters": {} }