virtual_endpoints

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

Overview

Name	virtual_endpoints
Type	Resource
Id	azure.postgresql.virtual_endpoints

Fields

vw_virtual_endpoints

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	text	The name of the resource
endpoint_type	text	field from the properties object
members	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
virtualEndpointName	text	field from the properties object
virtual_endpoints	text	field from the properties object

virtual_endpoints

Name	Datatype	Description
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
properties	object	The properties of a virtual endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serverName, subscriptionId, virtualEndpointName	Gets information about a virtual endpoint.
list_by_server	SELECT	resourceGroupName, serverName, subscriptionId	List all the servers in a given resource group.
create	INSERT	resourceGroupName, serverName, subscriptionId, virtualEndpointName	Creates a new virtual endpoint for PostgreSQL flexible server.
delete	DELETE	resourceGroupName, serverName, subscriptionId, virtualEndpointName	Deletes a virtual endpoint.
update	UPDATE	resourceGroupName, serverName, subscriptionId, virtualEndpointName	Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.

SELECT examples

List all the servers in a given resource group.

vw_virtual_endpoints

SELECT
id,
name,
endpoint_type,
members,
resourceGroupName,
serverName,
subscriptionId,
system_data,
type,
virtualEndpointName,
virtual_endpoints
FROM azure.postgresql.vw_virtual_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

virtual_endpoints

SELECT
id,
name,
properties,
systemData,
type
FROM azure.postgresql.virtual_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new virtual_endpoints resource.

All Properties

/*+ create */
INSERT INTO azure.postgresql.virtual_endpoints (
resourceGroupName,
serverName,
subscriptionId,
virtualEndpointName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}',
'{{ virtualEndpointName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: endpointType
          value: string
        - name: members
          value:
            - string
        - name: virtualEndpoints
          value:
            - string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a virtual_endpoints resource.

/*+ update */
UPDATE azure.postgresql.virtual_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualEndpointName = '{{ virtualEndpointName }}';

DELETE example

Deletes the specified virtual_endpoints resource.

/*+ delete */
DELETE FROM azure.postgresql.virtual_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualEndpointName = '{{ virtualEndpointName }}';