web_pub_sub_shared_private_link_resources

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

Overview

Name	web_pub_sub_shared_private_link_resources
Type	Resource
Id	azure.web_pubsub.web_pub_sub_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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupId	string	The group id from the provider of resource the shared private link resource is for.
privateLinkResourceId	string	The resource id of the resource the shared private link resource is for.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
requestMessage	string	The request message for requesting approval of the shared private link resource.
status	string	Status of the shared private link resource. Known values are: "Pending", "Approved", "Rejected", "Disconnected", and "Timeout".
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
groupId	string	The group id from the provider of resource the shared private link resource is for.
privateLinkResourceId	string	The resource id of the resource the shared private link resource is for.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
requestMessage	string	The request message for requesting approval of the shared private link resource.
status	string	Status of the shared private link resource. Known values are: "Pending", "Approved", "Rejected", "Disconnected", and "Timeout".
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	shared_private_link_resource_name, resource_group_name, resource_name, subscription_id		Get the specified shared private link resource.
list	select	resource_group_name, resource_name, subscription_id		List shared private link resources.
create_or_update	insert	shared_private_link_resource_name, resource_group_name, resource_name, subscription_id		Create or update a shared private link resource.
create_or_update	replace	shared_private_link_resource_name, resource_group_name, resource_name, subscription_id		Create or update a shared private link resource.
delete	delete	shared_private_link_resource_name, resource_group_name, resource_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the resource. Required.
shared_private_link_resource_name	string	The name of the shared private link resource. Required.
subscription_id	string

SELECT examples

get

Get the specified shared private link resource.

SELECT
id,
name,
groupId,
privateLinkResourceId,
provisioningState,
requestMessage,
status,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_shared_private_link_resources
WHERE shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List shared private link resources.

SELECT
id,
name,
groupId,
privateLinkResourceId,
provisioningState,
requestMessage,
status,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_shared_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a shared private link resource.

INSERT INTO azure.web_pubsub.web_pub_sub_shared_private_link_resources (
properties,
shared_private_link_resource_name,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ shared_private_link_resource_name }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_pub_sub_shared_private_link_resources
props:
  - name: shared_private_link_resource_name
    value: "{{ shared_private_link_resource_name }}"
    description: Required parameter for the web_pub_sub_shared_private_link_resources resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the web_pub_sub_shared_private_link_resources resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the web_pub_sub_shared_private_link_resources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the web_pub_sub_shared_private_link_resources resource.
  - name: properties
    value:
      groupId: "{{ groupId }}"
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      requestMessage: "{{ requestMessage }}"

REPLACE examples

create_or_update

Create or update a shared private link resource.

REPLACE azure.web_pubsub.web_pub_sub_shared_private_link_resources
SET 
properties = '{{ properties }}'
WHERE 
shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete the specified shared private link resource.

DELETE FROM azure.web_pubsub.web_pub_sub_shared_private_link_resources
WHERE shared_private_link_resource_name = '{{ shared_private_link_resource_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;