Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. databasewatcher
  5. getSharedPrivateLinkResource
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.databasewatcher.getSharedPrivateLinkResource

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a SharedPrivateLinkResource

Uses Azure REST API version 2024-10-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.

Using getSharedPrivateLinkResource

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 getSharedPrivateLinkResource(args: GetSharedPrivateLinkResourceArgs, opts?: InvokeOptions): Promise<GetSharedPrivateLinkResourceResult>
function getSharedPrivateLinkResourceOutput(args: GetSharedPrivateLinkResourceOutputArgs, opts?: InvokeOptions): Output<GetSharedPrivateLinkResourceResult>
Copy
def get_shared_private_link_resource(resource_group_name: Optional[str] = None,
                                     shared_private_link_resource_name: Optional[str] = None,
                                     watcher_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetSharedPrivateLinkResourceResult
def get_shared_private_link_resource_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                     shared_private_link_resource_name: Optional[pulumi.Input[str]] = None,
                                     watcher_name: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetSharedPrivateLinkResourceResult]
Copy
func LookupSharedPrivateLinkResource(ctx *Context, args *LookupSharedPrivateLinkResourceArgs, opts ...InvokeOption) (*LookupSharedPrivateLinkResourceResult, error)
func LookupSharedPrivateLinkResourceOutput(ctx *Context, args *LookupSharedPrivateLinkResourceOutputArgs, opts ...InvokeOption) LookupSharedPrivateLinkResourceResultOutput
Copy

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

public static class GetSharedPrivateLinkResource 
{
    public static Task<GetSharedPrivateLinkResourceResult> InvokeAsync(GetSharedPrivateLinkResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetSharedPrivateLinkResourceResult> Invoke(GetSharedPrivateLinkResourceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSharedPrivateLinkResourceResult> getSharedPrivateLinkResource(GetSharedPrivateLinkResourceArgs args, InvokeOptions options)
public static Output<GetSharedPrivateLinkResourceResult> getSharedPrivateLinkResource(GetSharedPrivateLinkResourceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databasewatcher:getSharedPrivateLinkResource
  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.
SharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The Shared Private Link resource name.
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.
SharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The Shared Private Link resource name.
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.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
String
The Shared Private Link resource name.
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.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
string
The Shared Private Link resource name.
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.
shared_private_link_resource_name
This property is required.
Changes to this property will trigger replacement.
str
The Shared Private Link resource name.
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.
sharedPrivateLinkResourceName
This property is required.
Changes to this property will trigger replacement.
String
The Shared Private Link resource name.
watcherName
This property is required.
Changes to this property will trigger replacement.
String
The database watcher name.

getSharedPrivateLinkResource Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
GroupId string
The group id from the provider of resource the shared private link resource is for.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
PrivateLinkResourceId string
The resource ID of the resource the shared private link resource is for.
ProvisioningState string
The provisioning state of the resource.
RequestMessage string
The request message for requesting approval of the shared private link resource.
Status string
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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"
DnsZone string
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'.
AzureApiVersion string
The Azure API version of the resource.
GroupId string
The group id from the provider of resource the shared private link resource is for.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
PrivateLinkResourceId string
The resource ID of the resource the shared private link resource is for.
ProvisioningState string
The provisioning state of the resource.
RequestMessage string
The request message for requesting approval of the shared private link resource.
Status string
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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"
DnsZone string
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'.
azureApiVersion String
The Azure API version of the resource.
groupId String
The group id from the provider of resource the shared private link resource is for.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
privateLinkResourceId String
The resource ID of the resource the shared private link resource is for.
provisioningState String
The provisioning state of the resource.
requestMessage String
The request message for requesting approval of the shared private link resource.
status String
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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"
dnsZone String
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'.
azureApiVersion string
The Azure API version of the resource.
groupId string
The group id from the provider of resource the shared private link resource is for.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the resource
privateLinkResourceId string
The resource ID of the resource the shared private link resource is for.
provisioningState string
The provisioning state of the resource.
requestMessage string
The request message for requesting approval of the shared private link resource.
status string
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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"
dnsZone string
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'.
azure_api_version str
The Azure API version of the resource.
group_id str
The group id from the provider of resource the shared private link resource is for.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the resource
private_link_resource_id str
The resource ID of the resource the shared private link resource is for.
provisioning_state str
The provisioning state of the resource.
request_message str
The request message for requesting approval of the shared private link resource.
status str
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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"
dns_zone str
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'.
azureApiVersion String
The Azure API version of the resource.
groupId String
The group id from the provider of resource the shared private link resource is for.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the resource
privateLinkResourceId String
The resource ID of the resource the shared private link resource is for.
provisioningState String
The provisioning state of the resource.
requestMessage String
The request message for requesting approval of the shared private link resource.
status String
Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.
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"
dnsZone String
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'.

Supporting Types

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.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native