cloud_endpoints

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

Overview

Name	cloud_endpoints
Type	Resource
Id	azure.storage_sync.cloud_endpoints

Fields

The following fields are returned by SELECT queries:

get

Cloud Endpoint object

Name	Datatype	Description
properties	object	Cloud Endpoint properties.

list_by_sync_group

Array of Cloud Endpoint resources in Sync Group

Name	Datatype	Description
properties	object	Cloud 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, cloudEndpointName		Get a given CloudEndpoint.
list_by_sync_group	select	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName		Get a CloudEndpoint List.
create	insert	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Create a new CloudEndpoint.
delete	delete	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Delete a given CloudEndpoint.
pre_backup	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Pre Backup a given CloudEndpoint.
post_backup	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Post Backup a given CloudEndpoint.
pre_restore	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Pre Restore a given CloudEndpoint.
restoreheartbeat	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Restore Heartbeat a given CloudEndpoint.
post_restore	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Post Restore a given CloudEndpoint.
trigger_change_detection	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.
afs_share_metadata_certificate_public_keys	exec	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName, cloudEndpointName		Get the AFS file share metadata signing certificate public keys.

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
cloudEndpointName	string	Name of Cloud Endpoint object.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
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 given CloudEndpoint.

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

list_by_sync_group

Get a CloudEndpoint List.

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

INSERT examples

create

Create a new CloudEndpoint.

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

Manifest

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

DELETE examples

delete

Delete a given CloudEndpoint.

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

Lifecycle Methods

pre_backup

Pre Backup a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.pre_backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required 
@@json=
'{
"azureFileShare": "{{ azureFileShare }}"
}'
;

post_backup

Post Backup a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.post_backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required 
@@json=
'{
"azureFileShare": "{{ azureFileShare }}"
}'
;

pre_restore

Pre Restore a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.pre_restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required 
@@json=
'{
"partition": "{{ partition }}", 
"replicaGroup": "{{ replicaGroup }}", 
"requestId": "{{ requestId }}", 
"azureFileShareUri": "{{ azureFileShareUri }}", 
"status": "{{ status }}", 
"sourceAzureFileShareUri": "{{ sourceAzureFileShareUri }}", 
"backupMetadataPropertyBag": "{{ backupMetadataPropertyBag }}", 
"restoreFileSpec": "{{ restoreFileSpec }}", 
"pauseWaitForSyncDrainTimePeriodInSeconds": {{ pauseWaitForSyncDrainTimePeriodInSeconds }}
}'
;

restoreheartbeat

Restore Heartbeat a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.restoreheartbeat 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required
;

post_restore

Post Restore a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.post_restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required 
@@json=
'{
"partition": "{{ partition }}", 
"replicaGroup": "{{ replicaGroup }}", 
"requestId": "{{ requestId }}", 
"azureFileShareUri": "{{ azureFileShareUri }}", 
"status": "{{ status }}", 
"sourceAzureFileShareUri": "{{ sourceAzureFileShareUri }}", 
"failedFileList": "{{ failedFileList }}", 
"restoreFileSpec": "{{ restoreFileSpec }}"
}'
;

trigger_change_detection

Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

EXEC azure.storage_sync.cloud_endpoints.trigger_change_detection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required 
@@json=
'{
"directoryPath": "{{ directoryPath }}", 
"changeDetectionMode": "{{ changeDetectionMode }}", 
"paths": "{{ paths }}"
}'
;

afs_share_metadata_certificate_public_keys

Get the AFS file share metadata signing certificate public keys.

EXEC azure.storage_sync.cloud_endpoints.afs_share_metadata_certificate_public_keys 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@syncGroupName='{{ syncGroupName }}' --required, 
@cloudEndpointName='{{ cloudEndpointName }}' --required
;