Microsoft.DatabaseWatcher (preview:2024-10-01)

2025/02/20 • 6 updated methods

SharedPrivateLinkResources_ListByWatcher (updated)
Description :  List SharedPrivateLinkResource resources by Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "SharedPrivateLinkResources_ListByWatcher",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "dnsZone",
                "Description": {
                  "new": "The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'.",
                  "old": "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."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SharedPrivateLinkResources_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "dnsZone",
            "Description": {
              "new": "The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'.",
              "old": "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."
            }
          }
        ]
      }
    }
  }
}

⚼ 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 segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'. ,
Required: False ,
}
string ,
status:
{
Description: Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. ,
Enum:
{
Pending: The shared private link connection request was not yet authorized by the resource owner. ,
Approved: The shared private link connection request was approved by the resource owner. ,
Rejected: The shared private link connection request was rejected by the resource owner. ,
Disconnected: The shared private link connection request was disconnected by the resource owner. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SharedPrivateLinkResources_Create",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "dnsZone",
            "Description": {
              "new": "The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'.",
              "old": "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."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "dnsZone",
            "Description": {
              "new": "The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'.",
              "old": "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."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "dnsZone",
            "Description": {
              "new": "The DNS zone segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'.",
              "old": "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."
            }
          }
        ]
      }
    }
  }
}

⚼ 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 segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'. ,
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 segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'. ,
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 segment to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances, and must be omitted for SQL logical servers and key vaults. The value is the second segment of the host FQDN name of the resource that the shared private link resource is for. For example: if the host name is 'adx-cluster-21187695.eastus.kusto.windows.net', then the value is 'eastus'; if the host name is 'sql-mi-23961134.767d5869f605.database.windows.net', then the value is '767d5869f605'. ,
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 ,
}
,
]
,
}
,
}
Targets_ListByWatcher (updated)
Description :  List Target resources by Watcher
Reference :  Link ¶

⚶ Changes

{
  "#id": "Targets_ListByWatcher",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "connectionServerName",
                "Description": {
                  "new": "The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately.",
                  "old": "The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ 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 FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Targets_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "connectionServerName",
            "Description": {
              "new": "The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately.",
              "old": "The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately."
            }
          }
        ]
      }
    }
  }
}

⚼ 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 FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "Targets_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "connectionServerName",
            "Description": {
              "new": "The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately.",
              "old": "The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "connectionServerName",
            "Description": {
              "new": "The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately.",
              "old": "The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "connectionServerName",
            "Description": {
              "new": "The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately.",
              "old": "The server name to use in the connection string when connecting to a target. Port number and instance name must be specified separately."
            }
          }
        ]
      }
    }
  }
}

⚼ 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 FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. 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 FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. 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 FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. 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 ,
}
,
]
,
}
,
}