azure-native.databasewatcher.Target
Explore with Pulumi AI
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.
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",
},
});
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"),
},
})
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());
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",
})
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",
},
});
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
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:
- Connection
Server Name 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.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Target
Authentication Type This property is required. string | Pulumi.Azure Native. Database Watcher. Target Authentication Type - The type of authentication to use when connecting to a target.
- Target
Type This property is required. string - Discriminator property for TargetProperties.
- Watcher
Name This property is required. Changes to this property will trigger replacement.
- The database watcher name.
- Target
Name Changes to this property will trigger replacement.
- The target resource name.
- Target
Vault Pulumi.Azure Native. Database Watcher. Inputs. Vault Secret - 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. 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.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Target
Authentication Type This property is required. string | TargetAuthentication Type - The type of authentication to use when connecting to a target.
- Target
Type This property is required. string - Discriminator property for TargetProperties.
- Watcher
Name This property is required. Changes to this property will trigger replacement.
- The database watcher name.
- Target
Name Changes to this property will trigger replacement.
- The target resource name.
- Target
Vault VaultSecret Args - 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. 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.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- target
Authentication Type This property is required. String | TargetAuthentication Type - The type of authentication to use when connecting to a target.
- target
Type This property is required. String - Discriminator property for TargetProperties.
- watcher
Name This property is required. Changes to this property will trigger replacement.
- The database watcher name.
- target
Name Changes to this property will trigger replacement.
- The target resource name.
- target
Vault 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. 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.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- target
Authentication Type This property is required. string | TargetAuthentication Type - The type of authentication to use when connecting to a target.
- target
Type This property is required. string - Discriminator property for TargetProperties.
- watcher
Name This property is required. Changes to this property will trigger replacement.
- The database watcher name.
- target
Name Changes to this property will trigger replacement.
- The target resource name.
- target
Vault 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.
- The name of the resource group. The name is case insensitive.
- target_
authentication_ type This property is required. str | TargetAuthentication Type - 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.
- The database watcher name.
- target_
name Changes to this property will trigger replacement.
- The target resource name.
- target_
vault VaultSecret Args - 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. 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.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- target
Authentication Type This property is required. String | "Aad" | "Sql" - The type of authentication to use when connecting to a target.
- target
Type This property is required. String - Discriminator property for TargetProperties.
- watcher
Name This property is required. Changes to this property will trigger replacement.
- The database watcher name.
- target
Name Changes to this property will trigger replacement.
- The target resource name.
- target
Vault 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:
- Azure
Api stringVersion - 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
- Provisioning
State string - The provisioning state of the resource.
- System
Data Pulumi.Azure Native. Database Watcher. Outputs. System Data Response - 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 stringVersion - 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
- Provisioning
State string - The provisioning state of the resource.
- System
Data SystemData Response - 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 StringVersion - 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
- provisioning
State String - The provisioning state of the resource.
- system
Data SystemData Response - 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 stringVersion - 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
- provisioning
State string - The provisioning state of the resource.
- system
Data SystemData Response - 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_ strversion - 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 SystemData Response - 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"
- azure
Api StringVersion - 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
- provisioning
State String - The provisioning state of the resource.
- system
Data 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
TargetAuthenticationType, TargetAuthenticationTypeArgs
- Aad
- AadThe Azure Active Directory authentication.
- Sql
- SqlThe SQL password authentication.
- Target
Authentication Type Aad - AadThe Azure Active Directory authentication.
- Target
Authentication Type 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.
- "Aad"
- AadThe Azure Active Directory authentication.
- "Sql"
- SqlThe SQL password authentication.
VaultSecret, VaultSecretArgs
- Akv
Resource stringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- Akv
Target stringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- Akv
Target stringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- Akv
Resource stringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- Akv
Target stringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- Akv
Target stringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv
Resource StringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv
Target StringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv
Target StringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv
Resource stringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv
Target stringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv
Target stringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv_
resource_ strid - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv_
target_ strpassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv_
target_ struser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv
Resource StringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv
Target StringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv
Target StringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
VaultSecretResponse, VaultSecretResponseArgs
- Akv
Resource stringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- Akv
Target stringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- Akv
Target stringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- Akv
Resource stringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- Akv
Target stringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- Akv
Target stringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv
Resource StringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv
Target StringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv
Target StringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv
Resource stringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv
Target stringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv
Target stringUser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv_
resource_ strid - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv_
target_ strpassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv_
target_ struser - The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target.
- akv
Resource StringId - The Azure resource ID of the Key Vault instance storing database authentication secrets.
- akv
Target StringPassword - The path to the Key Vault secret storing the password for authentication to a target.
- akv
Target StringUser - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0