1. Packages
  2. Azure Native
  3. API Docs
  4. databasewatcher
  5. Target
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.databasewatcher.Target

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Concrete proxy resource types can be created by aliasing this type using a specific property type.

Uses Azure REST API version 2024-10-01-preview. In version 2.x of the Azure Native provider, it used API version 2023-09-01-preview.

Other available API versions: 2023-09-01-preview, 2024-07-19-preview, 2025-01-02. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native databasewatcher [ApiVersion]. See the version guide for details.

Example Usage

Targets_CreateOrUpdate - generated by [MaximumSet] rule

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var target = new AzureNative.DatabaseWatcher.Target("target", new()
    {
        ConnectionServerName = "sqlServero1ihe2",
        ResourceGroupName = "apiTest-ddat4p",
        TargetAuthenticationType = AzureNative.DatabaseWatcher.TargetAuthenticationType.Aad,
        TargetName = "monitoringh22eed",
        TargetType = "SqlDb",
        WatcherName = "databasemo3ej9ih",
    });

});
Copy
package main

import (
	databasewatcher "github.com/pulumi/pulumi-azure-native-sdk/databasewatcher/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databasewatcher.NewTarget(ctx, "target", &databasewatcher.TargetArgs{
			ConnectionServerName:     pulumi.String("sqlServero1ihe2"),
			ResourceGroupName:        pulumi.String("apiTest-ddat4p"),
			TargetAuthenticationType: pulumi.String(databasewatcher.TargetAuthenticationTypeAad),
			TargetName:               pulumi.String("monitoringh22eed"),
			TargetType:               pulumi.String("SqlDb"),
			WatcherName:              pulumi.String("databasemo3ej9ih"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.databasewatcher.Target;
import com.pulumi.azurenative.databasewatcher.TargetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var target = new Target("target", TargetArgs.builder()
            .connectionServerName("sqlServero1ihe2")
            .resourceGroupName("apiTest-ddat4p")
            .targetAuthenticationType("Aad")
            .targetName("monitoringh22eed")
            .targetType("SqlDb")
            .watcherName("databasemo3ej9ih")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const target = new azure_native.databasewatcher.Target("target", {
    connectionServerName: "sqlServero1ihe2",
    resourceGroupName: "apiTest-ddat4p",
    targetAuthenticationType: azure_native.databasewatcher.TargetAuthenticationType.Aad,
    targetName: "monitoringh22eed",
    targetType: "SqlDb",
    watcherName: "databasemo3ej9ih",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

target = azure_native.databasewatcher.Target("target",
    connection_server_name="sqlServero1ihe2",
    resource_group_name="apiTest-ddat4p",
    target_authentication_type=azure_native.databasewatcher.TargetAuthenticationType.AAD,
    target_name="monitoringh22eed",
    target_type="SqlDb",
    watcher_name="databasemo3ej9ih")
Copy
resources:
  target:
    type: azure-native:databasewatcher:Target
    properties:
      connectionServerName: sqlServero1ihe2
      resourceGroupName: apiTest-ddat4p
      targetAuthenticationType: Aad
      targetName: monitoringh22eed
      targetType: SqlDb
      watcherName: databasemo3ej9ih
Copy

Create Target Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Target(name: string, args: TargetArgs, opts?: CustomResourceOptions);
@overload
def Target(resource_name: str,
           args: TargetArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Target(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           connection_server_name: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           target_authentication_type: Optional[Union[str, TargetAuthenticationType]] = None,
           target_type: Optional[str] = None,
           watcher_name: Optional[str] = None,
           target_name: Optional[str] = None,
           target_vault: Optional[VaultSecretArgs] = None)
func NewTarget(ctx *Context, name string, args TargetArgs, opts ...ResourceOption) (*Target, error)
public Target(string name, TargetArgs args, CustomResourceOptions? opts = null)
public Target(String name, TargetArgs args)
public Target(String name, TargetArgs args, CustomResourceOptions options)
type: azure-native:databasewatcher:Target
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TargetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TargetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TargetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TargetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TargetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azure_nativeTargetResource = new AzureNative.DatabaseWatcher.Target("azure-nativeTargetResource", new()
{
    ConnectionServerName = "string",
    ResourceGroupName = "string",
    TargetAuthenticationType = "string",
    TargetType = "string",
    WatcherName = "string",
    TargetName = "string",
    TargetVault = new AzureNative.DatabaseWatcher.Inputs.VaultSecretArgs
    {
        AkvResourceId = "string",
        AkvTargetPassword = "string",
        AkvTargetUser = "string",
    },
});
Copy
example, err := databasewatcher.NewTarget(ctx, "azure-nativeTargetResource", &databasewatcher.TargetArgs{
	ConnectionServerName:     pulumi.String("string"),
	ResourceGroupName:        pulumi.String("string"),
	TargetAuthenticationType: pulumi.String("string"),
	TargetType:               pulumi.String("string"),
	WatcherName:              pulumi.String("string"),
	TargetName:               pulumi.String("string"),
	TargetVault: &databasewatcher.VaultSecretArgs{
		AkvResourceId:     pulumi.String("string"),
		AkvTargetPassword: pulumi.String("string"),
		AkvTargetUser:     pulumi.String("string"),
	},
})
Copy
var azure_nativeTargetResource = new Target("azure-nativeTargetResource", TargetArgs.builder()
    .connectionServerName("string")
    .resourceGroupName("string")
    .targetAuthenticationType("string")
    .targetType("string")
    .watcherName("string")
    .targetName("string")
    .targetVault(VaultSecretArgs.builder()
        .akvResourceId("string")
        .akvTargetPassword("string")
        .akvTargetUser("string")
        .build())
    .build());
Copy
azure_native_target_resource = azure_native.databasewatcher.Target("azure-nativeTargetResource",
    connection_server_name="string",
    resource_group_name="string",
    target_authentication_type="string",
    target_type="string",
    watcher_name="string",
    target_name="string",
    target_vault={
        "akv_resource_id": "string",
        "akv_target_password": "string",
        "akv_target_user": "string",
    })
Copy
const azure_nativeTargetResource = new azure_native.databasewatcher.Target("azure-nativeTargetResource", {
    connectionServerName: "string",
    resourceGroupName: "string",
    targetAuthenticationType: "string",
    targetType: "string",
    watcherName: "string",
    targetName: "string",
    targetVault: {
        akvResourceId: "string",
        akvTargetPassword: "string",
        akvTargetUser: "string",
    },
});
Copy
type: azure-native:databasewatcher:Target
properties:
    connectionServerName: string
    resourceGroupName: string
    targetAuthenticationType: string
    targetName: string
    targetType: string
    targetVault:
        akvResourceId: string
        akvTargetPassword: string
        akvTargetUser: string
    watcherName: string
Copy

Target Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Target resource accepts the following input properties:

ConnectionServerName This property is required. string
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TargetAuthenticationType This property is required. string | Pulumi.AzureNative.DatabaseWatcher.TargetAuthenticationType
The type of authentication to use when connecting to a target.
TargetType This property is required. string
Discriminator property for TargetProperties.
WatcherName
This property is required.
Changes to this property will trigger replacement.
string
The database watcher name.
TargetName Changes to this property will trigger replacement. string
The target resource name.
TargetVault Pulumi.AzureNative.DatabaseWatcher.Inputs.VaultSecret
To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored.
ConnectionServerName This property is required. string
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
TargetAuthenticationType This property is required. string | TargetAuthenticationType
The type of authentication to use when connecting to a target.
TargetType This property is required. string
Discriminator property for TargetProperties.
WatcherName
This property is required.
Changes to this property will trigger replacement.
string
The database watcher name.
TargetName Changes to this property will trigger replacement. string
The target resource name.
TargetVault VaultSecretArgs
To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored.
connectionServerName This property is required. String
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
targetAuthenticationType This property is required. String | TargetAuthenticationType
The type of authentication to use when connecting to a target.
targetType This property is required. String
Discriminator property for TargetProperties.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The database watcher name.
targetName Changes to this property will trigger replacement. String
The target resource name.
targetVault VaultSecret
To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored.
connectionServerName This property is required. string
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
targetAuthenticationType This property is required. string | TargetAuthenticationType
The type of authentication to use when connecting to a target.
targetType This property is required. string
Discriminator property for TargetProperties.
watcherName
This property is required.
Changes to this property will trigger replacement.
string
The database watcher name.
targetName Changes to this property will trigger replacement. string
The target resource name.
targetVault VaultSecret
To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored.
connection_server_name This property is required. str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
target_authentication_type This property is required. str | TargetAuthenticationType
The type of authentication to use when connecting to a target.
target_type This property is required. str
Discriminator property for TargetProperties.
watcher_name
This property is required.
Changes to this property will trigger replacement.
str
The database watcher name.
target_name Changes to this property will trigger replacement. str
The target resource name.
target_vault VaultSecretArgs
To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored.
connectionServerName This property is required. String
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
targetAuthenticationType This property is required. String | "Aad" | "Sql"
The type of authentication to use when connecting to a target.
targetType This property is required. String
Discriminator property for TargetProperties.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The database watcher name.
targetName Changes to this property will trigger replacement. String
The target resource name.
targetVault Property Map
To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored.

Outputs

All input properties are implicitly available as output properties. Additionally, the Target resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
SystemData Pulumi.AzureNative.DatabaseWatcher.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
provisioningState string
The provisioning state of the resource.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
provisioning_state str
The provisioning state of the resource.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
provisioningState String
The provisioning state of the resource.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

TargetAuthenticationType
, TargetAuthenticationTypeArgs

Aad
AadThe Azure Active Directory authentication.
Sql
SqlThe SQL password authentication.
TargetAuthenticationTypeAad
AadThe Azure Active Directory authentication.
TargetAuthenticationTypeSql
SqlThe SQL password authentication.
Aad
AadThe Azure Active Directory authentication.
Sql
SqlThe SQL password authentication.
Aad
AadThe Azure Active Directory authentication.
Sql
SqlThe SQL password authentication.
AAD
AadThe Azure Active Directory authentication.
SQL
SqlThe SQL password authentication.
"Aad"
AadThe Azure Active Directory authentication.
"Sql"
SqlThe SQL password authentication.

VaultSecret
, VaultSecretArgs

AkvResourceId string
The Azure resource ID of the Key Vault instance storing database authentication secrets.
AkvTargetPassword string
The path to the Key Vault secret storing the password for authentication to a target.
AkvTargetUser string
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
AkvResourceId string
The Azure resource ID of the Key Vault instance storing database authentication secrets.
AkvTargetPassword string
The path to the Key Vault secret storing the password for authentication to a target.
AkvTargetUser string
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akvResourceId String
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akvTargetPassword String
The path to the Key Vault secret storing the password for authentication to a target.
akvTargetUser String
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akvResourceId string
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akvTargetPassword string
The path to the Key Vault secret storing the password for authentication to a target.
akvTargetUser string
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akv_resource_id str
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akv_target_password str
The path to the Key Vault secret storing the password for authentication to a target.
akv_target_user str
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akvResourceId String
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akvTargetPassword String
The path to the Key Vault secret storing the password for authentication to a target.
akvTargetUser String
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.

VaultSecretResponse
, VaultSecretResponseArgs

AkvResourceId string
The Azure resource ID of the Key Vault instance storing database authentication secrets.
AkvTargetPassword string
The path to the Key Vault secret storing the password for authentication to a target.
AkvTargetUser string
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
AkvResourceId string
The Azure resource ID of the Key Vault instance storing database authentication secrets.
AkvTargetPassword string
The path to the Key Vault secret storing the password for authentication to a target.
AkvTargetUser string
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akvResourceId String
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akvTargetPassword String
The path to the Key Vault secret storing the password for authentication to a target.
akvTargetUser String
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akvResourceId string
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akvTargetPassword string
The path to the Key Vault secret storing the password for authentication to a target.
akvTargetUser string
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akv_resource_id str
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akv_target_password str
The path to the Key Vault secret storing the password for authentication to a target.
akv_target_user str
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
akvResourceId String
The Azure resource ID of the Key Vault instance storing database authentication secrets.
akvTargetPassword String
The path to the Key Vault secret storing the password for authentication to a target.
akvTargetUser String
The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:databasewatcher:Target monitoringzkndgm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets/{targetName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi