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.web_pubsub.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	sharedPrivateLinkResourceName, subscriptionId, resourceGroupName, resourceName		Get the specified shared private link resource
list	select	subscriptionId, resourceGroupName, resourceName		List shared private link resources
create_or_update	insert	sharedPrivateLinkResourceName, subscriptionId, resourceGroupName, resourceName		Create or update a shared private link resource
delete	delete	sharedPrivateLinkResourceName, subscriptionId, resourceGroupName, resourceName		Delete the specified 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
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.shared_private_link_resources
WHERE sharedPrivateLinkResourceName = '{{ sharedPrivateLinkResourceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list

List shared private link resources

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

INSERT examples

create_or_update

Create or update a shared private link resource

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

Manifest

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

DELETE examples

delete

Delete the specified shared private link resource

DELETE FROM azure.web_pubsub.shared_private_link_resources
WHERE sharedPrivateLinkResourceName = '{{ sharedPrivateLinkResourceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;