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

vw_server_endpoints

Name	Datatype	Description
cloud_tiering	text	field from the properties object
cloud_tiering_status	text	field from the properties object
friendly_name	text	field from the properties object
initial_download_policy	text	field from the properties object
initial_upload_policy	text	field from the properties object
last_operation_name	text	field from the properties object
last_workflow_id	text	field from the properties object
local_cache_mode	text	field from the properties object
offline_data_transfer	text	field from the properties object
offline_data_transfer_share_name	text	field from the properties object
offline_data_transfer_storage_account_resource_id	text	field from the properties object
offline_data_transfer_storage_account_tenant_id	text	field from the properties object
provisioning_state	text	field from the properties object
recall_status	text	field from the properties object
resourceGroupName	text	field from the properties object
serverEndpointName	text	field from the properties object
server_endpoint_provisioning_status	text	field from the properties object
server_local_path	text	field from the properties object
server_name	text	field from the properties object
server_resource_id	text	field from the properties object
storageSyncServiceName	text	field from the properties object
subscriptionId	text	field from the properties object
syncGroupName	text	field from the properties object
sync_status	text	field from the properties object
tier_files_older_than_days	text	field from the properties object
volume_free_space_percent	text	field from the properties object

server_endpoints

Name	Datatype	Description
properties	object	ServerEndpoint Properties object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serverEndpointName, storageSyncServiceName, subscriptionId, syncGroupName	Get a ServerEndpoint.
list_by_sync_group	SELECT	resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Get a ServerEndpoint list.
create	INSERT	resourceGroupName, serverEndpointName, storageSyncServiceName, subscriptionId, syncGroupName	Create a new ServerEndpoint.
delete	DELETE	resourceGroupName, serverEndpointName, storageSyncServiceName, subscriptionId, syncGroupName	Delete a given ServerEndpoint.
update	UPDATE	resourceGroupName, serverEndpointName, storageSyncServiceName, subscriptionId, syncGroupName	Patch a given ServerEndpoint.
recall_action	EXEC	resourceGroupName, serverEndpointName, storageSyncServiceName, subscriptionId, syncGroupName	Recall a server endpoint.

SELECT examples

Get a ServerEndpoint list.

vw_server_endpoints

SELECT
cloud_tiering,
cloud_tiering_status,
friendly_name,
initial_download_policy,
initial_upload_policy,
last_operation_name,
last_workflow_id,
local_cache_mode,
offline_data_transfer,
offline_data_transfer_share_name,
offline_data_transfer_storage_account_resource_id,
offline_data_transfer_storage_account_tenant_id,
provisioning_state,
recall_status,
resourceGroupName,
serverEndpointName,
server_endpoint_provisioning_status,
server_local_path,
server_name,
server_resource_id,
storageSyncServiceName,
subscriptionId,
syncGroupName,
sync_status,
tier_files_older_than_days,
volume_free_space_percent
FROM azure.storage_sync.vw_server_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND storageSyncServiceName = '{{ storageSyncServiceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND syncGroupName = '{{ syncGroupName }}';

server_endpoints

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.storage_sync.server_endpoints (
resourceGroupName,
serverEndpointName,
storageSyncServiceName,
subscriptionId,
syncGroupName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ serverEndpointName }}',
'{{ storageSyncServiceName }}',
'{{ subscriptionId }}',
'{{ syncGroupName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: serverLocalPath
          value: []
        - name: cloudTiering
          value: []
        - name: volumeFreeSpacePercent
          value: integer
        - name: tierFilesOlderThanDays
          value: integer
        - name: friendlyName
          value: string
        - name: serverResourceId
          value: []
        - name: offlineDataTransferShareName
          value: string
        - name: initialDownloadPolicy
          value: []
        - name: localCacheMode
          value: []
        - name: initialUploadPolicy
          value: []

UPDATE example

Updates a server_endpoints resource.

/*+ update */
UPDATE azure.storage_sync.server_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND serverEndpointName = '{{ serverEndpointName }}'
AND storageSyncServiceName = '{{ storageSyncServiceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND syncGroupName = '{{ syncGroupName }}';

DELETE example

Deletes the specified server_endpoints resource.

/*+ delete */
DELETE FROM azure.storage_sync.server_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverEndpointName = '{{ serverEndpointName }}'
AND storageSyncServiceName = '{{ storageSyncServiceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND syncGroupName = '{{ syncGroupName }}';