virtual_endpoints

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

Overview

Name	virtual_endpoints
Type	Resource
Id	azure.postgresql_flexible_servers.virtual_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endpointType	string	Type of endpoint for the virtual endpoints. "ReadWrite" (ReadWrite)
members	array	List of servers that one of the virtual endpoints can refer to.
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".
virtualEndpoints	array	List of virtual endpoints for a server.

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endpointType	string	Type of endpoint for the virtual endpoints. "ReadWrite" (ReadWrite)
members	array	List of servers that one of the virtual endpoints can refer to.
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".
virtualEndpoints	array	List of virtual endpoints for a server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, virtual_endpoint_name, subscription_id		Gets information about a pair of virtual endpoints.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists pair of virtual endpoints associated to a server.
create	insert	resource_group_name, server_name, virtual_endpoint_name, subscription_id		Creates a pair of virtual endpoints for a server.
update	update	resource_group_name, server_name, virtual_endpoint_name, subscription_id		Updates a pair of virtual endpoints for a server.
delete	delete	resource_group_name, server_name, virtual_endpoint_name, subscription_id		Deletes a pair of virtual endpoints.

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.
server_name	string	The name of the server. Required.
subscription_id	string
virtual_endpoint_name	string	Base name of the virtual endpoints. Required.

SELECT examples

get

Gets information about a pair of virtual endpoints.

SELECT
id,
name,
endpointType,
members,
systemData,
type,
virtualEndpoints
FROM azure.postgresql_flexible_servers.virtual_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND virtual_endpoint_name = '{{ virtual_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists pair of virtual endpoints associated to a server.

SELECT
id,
name,
endpointType,
members,
systemData,
type,
virtualEndpoints
FROM azure.postgresql_flexible_servers.virtual_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a pair of virtual endpoints for a server.

INSERT INTO azure.postgresql_flexible_servers.virtual_endpoints (
properties,
resource_group_name,
server_name,
virtual_endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ virtual_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_endpoints resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the virtual_endpoints resource.
  - name: virtual_endpoint_name
    value: "{{ virtual_endpoint_name }}"
    description: Required parameter for the virtual_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_endpoints resource.
  - name: properties
    description: |
      Properties of the pair of virtual endpoints.
    value:
      endpointType: "{{ endpointType }}"
      members:
        - "{{ members }}"
      virtualEndpoints:
        - "{{ virtualEndpoints }}"

UPDATE examples

update

Updates a pair of virtual endpoints for a server.

UPDATE azure.postgresql_flexible_servers.virtual_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND virtual_endpoint_name = '{{ virtual_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a pair of virtual endpoints.

DELETE FROM azure.postgresql_flexible_servers.virtual_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND virtual_endpoint_name = '{{ virtual_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;