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

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.
cloudTiering	string	Cloud Tiering. Known values are: "on" and "off".
cloudTieringStatus	object	Cloud tiering status. Only populated if cloud tiering is enabled.
friendlyName	string	Friendly Name.
initialDownloadPolicy	string	Policy for how namespace and files are recalled during FastDr. Known values are: "NamespaceOnly", "NamespaceThenModifiedFiles", and "AvoidTieredFiles".
initialUploadPolicy	string	Policy for how the initial upload sync session is performed. Known values are: "ServerAuthoritative" and "Merge".
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	ServerEndpoint lastWorkflowId.
localCacheMode	string	Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: "DownloadNewAndModifiedFiles" and "UpdateLocallyCachedFiles".
offlineDataTransfer	string	Offline data transfer. Known values are: "on" and "off".
offlineDataTransferShareName	string	Offline data transfer share name.
offlineDataTransferStorageAccountResourceId	string	Offline data transfer storage account resource ID.
offlineDataTransferStorageAccountTenantId	string	Offline data transfer storage account tenant ID.
provisioningState	string	ServerEndpoint Provisioning State.
recallStatus	object	Recall status. Only populated if cloud tiering is enabled.
serverLocalPath	string	Server Local path.
serverName	string	Server name.
serverResourceId	string	Server Resource Id.
syncStatus	object	Server Endpoint sync status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tierFilesOlderThanDays	integer	Tier files older than days.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
volumeFreeSpacePercent	integer	Level of free space to be maintained by Cloud Tiering if it is enabled.

list_by_sync_group

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.
cloudTiering	string	Cloud Tiering. Known values are: "on" and "off".
cloudTieringStatus	object	Cloud tiering status. Only populated if cloud tiering is enabled.
friendlyName	string	Friendly Name.
initialDownloadPolicy	string	Policy for how namespace and files are recalled during FastDr. Known values are: "NamespaceOnly", "NamespaceThenModifiedFiles", and "AvoidTieredFiles".
initialUploadPolicy	string	Policy for how the initial upload sync session is performed. Known values are: "ServerAuthoritative" and "Merge".
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	ServerEndpoint lastWorkflowId.
localCacheMode	string	Policy for enabling follow-the-sun business models: link local cache to cloud behavior to pre-populate before local access. Known values are: "DownloadNewAndModifiedFiles" and "UpdateLocallyCachedFiles".
offlineDataTransfer	string	Offline data transfer. Known values are: "on" and "off".
offlineDataTransferShareName	string	Offline data transfer share name.
offlineDataTransferStorageAccountResourceId	string	Offline data transfer storage account resource ID.
offlineDataTransferStorageAccountTenantId	string	Offline data transfer storage account tenant ID.
provisioningState	string	ServerEndpoint Provisioning State.
recallStatus	object	Recall status. Only populated if cloud tiering is enabled.
serverLocalPath	string	Server Local path.
serverName	string	Server name.
serverResourceId	string	Server Resource Id.
syncStatus	object	Server Endpoint sync status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tierFilesOlderThanDays	integer	Tier files older than days.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
volumeFreeSpacePercent	integer	Level of free space to be maintained by Cloud Tiering if it is enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, subscription_id		Get a ServerEndpoint.
list_by_sync_group	select	resource_group_name, storage_sync_service_name, sync_group_name, subscription_id		Get a ServerEndpoint list.
create	insert	resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, subscription_id		Create a new ServerEndpoint.
update	update	resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, subscription_id		Patch a given ServerEndpoint.
delete	delete	resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, subscription_id		Delete a given ServerEndpoint.
recall_action	exec	resource_group_name, storage_sync_service_name, sync_group_name, server_endpoint_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_endpoint_name	string	Name of Server Endpoint object. Required.
storage_sync_service_name	string	Name of Storage Sync Service resource. Required.
subscription_id	string
sync_group_name	string	Name of Sync Group resource. Required.

SELECT examples

get

Get a ServerEndpoint.

SELECT
id,
name,
cloudTiering,
cloudTieringStatus,
friendlyName,
initialDownloadPolicy,
initialUploadPolicy,
lastOperationName,
lastWorkflowId,
localCacheMode,
offlineDataTransfer,
offlineDataTransferShareName,
offlineDataTransferStorageAccountResourceId,
offlineDataTransferStorageAccountTenantId,
provisioningState,
recallStatus,
serverLocalPath,
serverName,
serverResourceId,
syncStatus,
systemData,
tierFilesOlderThanDays,
type,
volumeFreeSpacePercent
FROM azure.storage_sync.server_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND sync_group_name = '{{ sync_group_name }}' -- required
AND server_endpoint_name = '{{ server_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_sync_group

Get a ServerEndpoint list.

SELECT
id,
name,
cloudTiering,
cloudTieringStatus,
friendlyName,
initialDownloadPolicy,
initialUploadPolicy,
lastOperationName,
lastWorkflowId,
localCacheMode,
offlineDataTransfer,
offlineDataTransferShareName,
offlineDataTransferStorageAccountResourceId,
offlineDataTransferStorageAccountTenantId,
provisioningState,
recallStatus,
serverLocalPath,
serverName,
serverResourceId,
syncStatus,
systemData,
tierFilesOlderThanDays,
type,
volumeFreeSpacePercent
FROM azure.storage_sync.server_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND sync_group_name = '{{ sync_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new ServerEndpoint.

INSERT INTO azure.storage_sync.server_endpoints (
properties,
resource_group_name,
storage_sync_service_name,
sync_group_name,
server_endpoint_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ storage_sync_service_name }}',
'{{ sync_group_name }}',
'{{ server_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_endpoints resource.
  - name: storage_sync_service_name
    value: "{{ storage_sync_service_name }}"
    description: Required parameter for the server_endpoints resource.
  - name: sync_group_name
    value: "{{ sync_group_name }}"
    description: Required parameter for the server_endpoints resource.
  - name: server_endpoint_name
    value: "{{ server_endpoint_name }}"
    description: Required parameter for the server_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_endpoints resource.
  - name: properties
    value:
      serverLocalPath: "{{ serverLocalPath }}"
      cloudTiering: "{{ cloudTiering }}"
      volumeFreeSpacePercent: {{ volumeFreeSpacePercent }}
      tierFilesOlderThanDays: {{ tierFilesOlderThanDays }}
      friendlyName: "{{ friendlyName }}"
      serverResourceId: "{{ serverResourceId }}"
      offlineDataTransfer: "{{ offlineDataTransfer }}"
      offlineDataTransferShareName: "{{ offlineDataTransferShareName }}"
      initialDownloadPolicy: "{{ initialDownloadPolicy }}"
      localCacheMode: "{{ localCacheMode }}"
      initialUploadPolicy: "{{ initialUploadPolicy }}"

UPDATE examples

update

Patch a given ServerEndpoint.

UPDATE azure.storage_sync.server_endpoints
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' --required
AND sync_group_name = '{{ sync_group_name }}' --required
AND server_endpoint_name = '{{ server_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a given ServerEndpoint.

DELETE FROM azure.storage_sync.server_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' --required
AND sync_group_name = '{{ sync_group_name }}' --required
AND server_endpoint_name = '{{ server_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

recall_action

Recall a server endpoint.

EXEC azure.storage_sync.server_endpoints.recall_action 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@server_endpoint_name='{{ server_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"pattern": "{{ pattern }}", 
"recallPath": "{{ recallPath }}"
}'
;