virtual_endpoints

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

Overview

Name	virtual_endpoints
Type	Resource
Id	azure.postgresql.virtual_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	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	Properties of the virtual endpoint resource.
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_server

Name	Datatype	Description
id	string (arm-id)	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	Properties of the virtual endpoint resource.
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	subscriptionId, resourceGroupName, serverName, virtualEndpointName		Gets information about a virtual endpoint.
list_by_server	select	subscriptionId, resourceGroupName, serverName		List all the servers in a given resource group.
create	insert	subscriptionId, resourceGroupName, serverName, virtualEndpointName		Creates a new virtual endpoint for PostgreSQL flexible server.
update	update	subscriptionId, resourceGroupName, serverName, virtualEndpointName		Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.
delete	delete	subscriptionId, resourceGroupName, serverName, virtualEndpointName		Deletes a virtual endpoint.

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.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
virtualEndpointName	string	The name of the virtual endpoint.

SELECT examples

get

Gets information about a virtual endpoint.

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

list_by_server

List all the servers in a given resource group.

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

INSERT examples

create

Creates a new virtual endpoint for PostgreSQL flexible server.

INSERT INTO azure.postgresql.virtual_endpoints (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
virtualEndpointName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ virtualEndpointName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_endpoints
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_endpoints resource.
    - name: serverName
      value: string
      description: Required parameter for the virtual_endpoints resource.
    - name: virtualEndpointName
      value: string
      description: Required parameter for the virtual_endpoints resource.
    - name: properties
      value: object
      description: |
        Properties of the virtual endpoint resource.

UPDATE examples

update

Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.

UPDATE azure.postgresql.virtual_endpoints
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND virtualEndpointName = '{{ virtualEndpointName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a virtual endpoint.

DELETE FROM azure.postgresql.virtual_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND virtualEndpointName = '{{ virtualEndpointName }}' --required
;