Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. databasewatcher
  5. getWatcher
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.databasewatcher.getWatcher

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a Watcher Azure REST API version: 2023-09-01-preview.

Other available API versions: 2024-07-19-preview, 2024-10-01-preview.

Using getWatcher

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWatcher(args: GetWatcherArgs, opts?: InvokeOptions): Promise<GetWatcherResult>
function getWatcherOutput(args: GetWatcherOutputArgs, opts?: InvokeOptions): Output<GetWatcherResult>
Copy
def get_watcher(resource_group_name: Optional[str] = None,
                watcher_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetWatcherResult
def get_watcher_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                watcher_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetWatcherResult]
Copy
func LookupWatcher(ctx *Context, args *LookupWatcherArgs, opts ...InvokeOption) (*LookupWatcherResult, error)
func LookupWatcherOutput(ctx *Context, args *LookupWatcherOutputArgs, opts ...InvokeOption) LookupWatcherResultOutput
Copy

> Note: This function is named LookupWatcher in the Go SDK.

public static class GetWatcher 
{
    public static Task<GetWatcherResult> InvokeAsync(GetWatcherArgs args, InvokeOptions? opts = null)
    public static Output<GetWatcherResult> Invoke(GetWatcherInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWatcherResult> getWatcher(GetWatcherArgs args, InvokeOptions options)
public static Output<GetWatcherResult> getWatcher(GetWatcherArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databasewatcher:getWatcher
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WatcherName
This property is required.
Changes to this property will trigger replacement.
string
The database watcher name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
WatcherName
This property is required.
Changes to this property will trigger replacement.
string
The database watcher name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The database watcher name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
watcherName
This property is required.
Changes to this property will trigger replacement.
string
The database watcher name.
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.
watcher_name
This property is required.
Changes to this property will trigger replacement.
str
The database watcher name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The database watcher name.

getWatcher Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource watcher.
Status string
The monitoring collection status of the watcher.
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"
Datastore Pulumi.AzureNative.DatabaseWatcher.Outputs.DatastoreResponse
The data store for collected monitoring data.
Identity Pulumi.AzureNative.DatabaseWatcher.Outputs.ManagedServiceIdentityResponse
The managed service identities assigned to this resource.
Tags Dictionary<string, string>
Resource tags.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
ProvisioningState string
The provisioning state of the resource watcher.
Status string
The monitoring collection status of the watcher.
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"
Datastore DatastoreResponse
The data store for collected monitoring data.
Identity ManagedServiceIdentityResponse
The managed service identities assigned to this resource.
Tags map[string]string
Resource tags.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the resource watcher.
status String
The monitoring collection status of the watcher.
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"
datastore DatastoreResponse
The data store for collected monitoring data.
identity ManagedServiceIdentityResponse
The managed service identities assigned to this resource.
tags Map<String,String>
Resource tags.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
provisioningState string
The provisioning state of the resource watcher.
status string
The monitoring collection status of the watcher.
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"
datastore DatastoreResponse
The data store for collected monitoring data.
identity ManagedServiceIdentityResponse
The managed service identities assigned to this resource.
tags {[key: string]: string}
Resource tags.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
provisioning_state str
The provisioning state of the resource watcher.
status str
The monitoring collection status of the watcher.
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"
datastore DatastoreResponse
The data store for collected monitoring data.
identity ManagedServiceIdentityResponse
The managed service identities assigned to this resource.
tags Mapping[str, str]
Resource tags.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
provisioningState String
The provisioning state of the resource watcher.
status String
The monitoring collection status of the watcher.
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"
datastore Property Map
The data store for collected monitoring data.
identity Property Map
The managed service identities assigned to this resource.
tags Map<String>
Resource tags.

Supporting Types

DatastoreResponse

KustoClusterUri This property is required. string
The Kusto cluster URI.
KustoDataIngestionUri This property is required. string
The Kusto data ingestion URI.
KustoDatabaseName This property is required. string
The name of a Kusto database.
KustoManagementUrl This property is required. string
The Kusto management URL.
KustoOfferingType This property is required. string
The type of a Kusto offering.
AdxClusterResourceId string
The Azure ResourceId of an Azure Data Explorer cluster.
KustoClusterDisplayName string
The Kusto cluster display name.
KustoClusterUri This property is required. string
The Kusto cluster URI.
KustoDataIngestionUri This property is required. string
The Kusto data ingestion URI.
KustoDatabaseName This property is required. string
The name of a Kusto database.
KustoManagementUrl This property is required. string
The Kusto management URL.
KustoOfferingType This property is required. string
The type of a Kusto offering.
AdxClusterResourceId string
The Azure ResourceId of an Azure Data Explorer cluster.
KustoClusterDisplayName string
The Kusto cluster display name.
kustoClusterUri This property is required. String
The Kusto cluster URI.
kustoDataIngestionUri This property is required. String
The Kusto data ingestion URI.
kustoDatabaseName This property is required. String
The name of a Kusto database.
kustoManagementUrl This property is required. String
The Kusto management URL.
kustoOfferingType This property is required. String
The type of a Kusto offering.
adxClusterResourceId String
The Azure ResourceId of an Azure Data Explorer cluster.
kustoClusterDisplayName String
The Kusto cluster display name.
kustoClusterUri This property is required. string
The Kusto cluster URI.
kustoDataIngestionUri This property is required. string
The Kusto data ingestion URI.
kustoDatabaseName This property is required. string
The name of a Kusto database.
kustoManagementUrl This property is required. string
The Kusto management URL.
kustoOfferingType This property is required. string
The type of a Kusto offering.
adxClusterResourceId string
The Azure ResourceId of an Azure Data Explorer cluster.
kustoClusterDisplayName string
The Kusto cluster display name.
kusto_cluster_uri This property is required. str
The Kusto cluster URI.
kusto_data_ingestion_uri This property is required. str
The Kusto data ingestion URI.
kusto_database_name This property is required. str
The name of a Kusto database.
kusto_management_url This property is required. str
The Kusto management URL.
kusto_offering_type This property is required. str
The type of a Kusto offering.
adx_cluster_resource_id str
The Azure ResourceId of an Azure Data Explorer cluster.
kusto_cluster_display_name str
The Kusto cluster display name.
kustoClusterUri This property is required. String
The Kusto cluster URI.
kustoDataIngestionUri This property is required. String
The Kusto data ingestion URI.
kustoDatabaseName This property is required. String
The name of a Kusto database.
kustoManagementUrl This property is required. String
The Kusto management URL.
kustoOfferingType This property is required. String
The type of a Kusto offering.
adxClusterResourceId String
The Azure ResourceId of an Azure Data Explorer cluster.
kustoClusterDisplayName String
The Kusto cluster display name.

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.DatabaseWatcher.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

SystemDataResponse

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.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native