shared_private_link_resources

Creates, updates, deletes, gets or lists a shared_private_link_resources resource.

Overview

Name	shared_private_link_resources
Type	Resource
Id	azure.database_watcher.shared_private_link_resources

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
dnsZone	string	The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for.
groupId	string	The group id from the provider of resource the shared private link resource is for. Required.
privateLinkResourceId	string	The resource ID of the resource the shared private link resource is for. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
requestMessage	string	The request message for requesting approval of the shared private link resource. Required.
status	string	Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". (Pending, Approved, Rejected, Disconnected)
systemData	object	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".

list_by_watcher

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
dnsZone	string	The DNS zone to be included in the DNS name of the shared private link. Value is required for Azure Data Explorer clusters and SQL managed instances. The value to use is the second segment of the host FQDN name of the resource that the shared private link resource is for.
groupId	string	The group id from the provider of resource the shared private link resource is for. Required.
privateLinkResourceId	string	The resource ID of the resource the shared private link resource is for. Required.
provisioningState	string	The provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
requestMessage	string	The request message for requesting approval of the shared private link resource. Required.
status	string	Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". (Pending, Approved, Rejected, Disconnected)
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, watcher_name, shared_private_link_resource_name, subscription_id		Get a SharedPrivateLinkResource.
list_by_watcher	select	resource_group_name, watcher_name, subscription_id		List SharedPrivateLinkResource resources by Watcher.
create	insert	resource_group_name, watcher_name, shared_private_link_resource_name, subscription_id		Create a SharedPrivateLinkResource.
delete	delete	resource_group_name, watcher_name, shared_private_link_resource_name, subscription_id		Delete a SharedPrivateLinkResource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
shared_private_link_resource_name	string	The Shared Private Link resource name. Required.
subscription_id	string
watcher_name	string	The database watcher name. Required.

SELECT examples

get

Get a SharedPrivateLinkResource.

SELECT
id,
name,
dnsZone,
groupId,
privateLinkResourceId,
provisioningState,
requestMessage,
status,
systemData,
type
FROM azure.database_watcher.shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND watcher_name = '{{ watcher_name }}' -- required
AND shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_watcher

List SharedPrivateLinkResource resources by Watcher.

SELECT
id,
name,
dnsZone,
groupId,
privateLinkResourceId,
provisioningState,
requestMessage,
status,
systemData,
type
FROM azure.database_watcher.shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND watcher_name = '{{ watcher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a SharedPrivateLinkResource.

INSERT INTO azure.database_watcher.shared_private_link_resources (
properties,
resource_group_name,
watcher_name,
shared_private_link_resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ watcher_name }}',
'{{ shared_private_link_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: shared_private_link_resources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: watcher_name
    value: "{{ watcher_name }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: shared_private_link_resource_name
    value: "{{ shared_private_link_resource_name }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the shared_private_link_resources resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      groupId: "{{ groupId }}"
      requestMessage: "{{ requestMessage }}"
      dnsZone: "{{ dnsZone }}"
      status: "{{ status }}"
      provisioningState: "{{ provisioningState }}"

DELETE examples

delete

Delete a SharedPrivateLinkResource.

DELETE FROM azure.database_watcher.shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND watcher_name = '{{ watcher_name }}' --required
AND shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;