server_endpoints

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

Overview

Name	server_endpoints
Type	Resource
Id	azure.storage_sync.server_endpoints

Fields

The following fields are returned by SELECT queries:

get

Server Endpoint object

Name	Datatype	Description
properties	object	Server Endpoint properties.

list_by_sync_group

Array of Server Endpoint resources in Sync Group

Name	Datatype	Description
properties	object	Server Endpoint properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, serverEndpointName		Get a ServerEndpoint.
list_by_sync_group	select	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName		Get a ServerEndpoint list.
create	insert	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, serverEndpointName		Create a new ServerEndpoint.
update	update	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, serverEndpointName		Patch a given ServerEndpoint.
delete	delete	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, serverEndpointName		Delete a given ServerEndpoint.
recall_action	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, serverEndpointName		Recall a server 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.
serverEndpointName	string	Name of Server Endpoint object.
storageSyncServiceName	string	Name of Storage Sync Service resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
syncGroupName	string	Name of Sync Group resource.

SELECT examples

get

Get a ServerEndpoint.

SELECT
properties
FROM azure.storage_sync.server_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' -- required
AND syncGroupName = '{{ syncGroupName }}' -- required
AND serverEndpointName = '{{ serverEndpointName }}' -- required
;

list_by_sync_group

Get a ServerEndpoint list.

SELECT
properties
FROM azure.storage_sync.server_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' -- required
AND syncGroupName = '{{ syncGroupName }}' -- required
;

INSERT examples

create

Create a new ServerEndpoint.

INSERT INTO azure.storage_sync.server_endpoints (
data__properties,
subscriptionId,
resourceGroupName,
storageSyncServiceName,
syncGroupName,
serverEndpointName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageSyncServiceName }}',
'{{ syncGroupName }}',
'{{ serverEndpointName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: server_endpoints
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the server_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the server_endpoints resource.
    - name: storageSyncServiceName
      value: string
      description: Required parameter for the server_endpoints resource.
    - name: syncGroupName
      value: string
      description: Required parameter for the server_endpoints resource.
    - name: serverEndpointName
      value: string
      description: Required parameter for the server_endpoints resource.
    - name: properties
      value: object
      description: |
        The parameters used to create the server endpoint.

UPDATE examples

update

Patch a given ServerEndpoint.

UPDATE azure.storage_sync.server_endpoints
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' --required
AND syncGroupName = '{{ syncGroupName }}' --required
AND serverEndpointName = '{{ serverEndpointName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete a given ServerEndpoint.

DELETE FROM azure.storage_sync.server_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' --required
AND syncGroupName = '{{ syncGroupName }}' --required
AND serverEndpointName = '{{ serverEndpointName }}' --required
;

Lifecycle Methods

recall_action

Recall a server endpoint.

EXEC azure.storage_sync.server_endpoints.recall_action 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@serverEndpointName='{{ serverEndpointName }}' --required 
@@json=
'{
"pattern": "{{ pattern }}", 
"recallPath": "{{ recallPath }}"
}'
;