replica_shared_private_link_resources

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

Overview

Name	replica_shared_private_link_resources
Type	Resource
Id	azure.web_pubsub.replica_shared_private_link_resources

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes a shared private link resource.

Name	Datatype	Description
properties	object	Describes the properties of an existing Shared Private Link Resource

list

Success. The response describes a list of shared private link resources.

Name	Datatype	Description
properties	object	Describes the properties of an existing Shared Private Link Resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, replicaName, sharedPrivateLinkResourceName		Get the specified shared private link resource
list	select	subscriptionId, resourceGroupName, resourceName, replicaName		List shared private link resources
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, replicaName, sharedPrivateLinkResourceName		Create or update a shared private link resource

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
replicaName	string	The name of the replica.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the resource.
sharedPrivateLinkResourceName	string	The name of the shared private link resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the specified shared private link resource

SELECT
properties
FROM azure.web_pubsub.replica_shared_private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND replicaName = '{{ replicaName }}' -- required
AND sharedPrivateLinkResourceName = '{{ sharedPrivateLinkResourceName }}' -- required
;

list

List shared private link resources

SELECT
properties
FROM azure.web_pubsub.replica_shared_private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND replicaName = '{{ replicaName }}' -- required
;

INSERT examples

create_or_update

Create or update a shared private link resource

INSERT INTO azure.web_pubsub.replica_shared_private_link_resources (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
replicaName,
sharedPrivateLinkResourceName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ replicaName }}',
'{{ sharedPrivateLinkResourceName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: replica_shared_private_link_resources
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the replica_shared_private_link_resources resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replica_shared_private_link_resources resource.
    - name: resourceName
      value: string
      description: Required parameter for the replica_shared_private_link_resources resource.
    - name: replicaName
      value: string
      description: Required parameter for the replica_shared_private_link_resources resource.
    - name: sharedPrivateLinkResourceName
      value: string
      description: Required parameter for the replica_shared_private_link_resources resource.
    - name: properties
      value: object
      description: |
        Describes the properties of an existing Shared Private Link Resource