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

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.
azureFileShareName	string	Azure file share name.
backupEnabled	string	Backup Enabled.
changeEnumerationStatus	object	Cloud endpoint change enumeration status.
friendlyName	string	Friendly Name.
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	CloudEndpoint lastWorkflowId.
partnershipId	string	Partnership Id.
provisioningState	string	CloudEndpoint Provisioning State.
storageAccountResourceId	string	Storage Account Resource Id.
storageAccountTenantId	string	Storage Account Tenant Id.
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".

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.
azureFileShareName	string	Azure file share name.
backupEnabled	string	Backup Enabled.
changeEnumerationStatus	object	Cloud endpoint change enumeration status.
friendlyName	string	Friendly Name.
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	CloudEndpoint lastWorkflowId.
partnershipId	string	Partnership Id.
provisioningState	string	CloudEndpoint Provisioning State.
storageAccountResourceId	string	Storage Account Resource Id.
storageAccountTenantId	string	Storage Account Tenant Id.
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".

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, cloud_endpoint_name, subscription_id		Get a given CloudEndpoint.
list_by_sync_group	select	resource_group_name, storage_sync_service_name, sync_group_name, subscription_id		Get a CloudEndpoint List.
create	insert	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Create a new CloudEndpoint.
delete	delete	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Delete a given CloudEndpoint.
pre_backup	exec	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Pre Backup a given CloudEndpoint.
post_backup	exec	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Post Backup a given CloudEndpoint.
pre_restore	exec	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Pre Restore a given CloudEndpoint.
restoreheartbeat	exec	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Restore Heartbeat a given CloudEndpoint.
post_restore	exec	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Post Restore a given CloudEndpoint.
trigger_change_detection	exec	resource_group_name, storage_sync_service_name, sync_group_name, cloud_endpoint_name, subscription_id		Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud 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
cloud_endpoint_name	string	Name of Cloud Endpoint object. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. 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 given CloudEndpoint.

SELECT
id,
name,
azureFileShareName,
backupEnabled,
changeEnumerationStatus,
friendlyName,
lastOperationName,
lastWorkflowId,
partnershipId,
provisioningState,
storageAccountResourceId,
storageAccountTenantId,
systemData,
type
FROM azure.storage_sync.cloud_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 cloud_endpoint_name = '{{ cloud_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_sync_group

Get a CloudEndpoint List.

SELECT
id,
name,
azureFileShareName,
backupEnabled,
changeEnumerationStatus,
friendlyName,
lastOperationName,
lastWorkflowId,
partnershipId,
provisioningState,
storageAccountResourceId,
storageAccountTenantId,
systemData,
type
FROM azure.storage_sync.cloud_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 CloudEndpoint.

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

Manifest

# Description fields are for documentation purposes
- name: cloud_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cloud_endpoints resource.
  - name: storage_sync_service_name
    value: "{{ storage_sync_service_name }}"
    description: Required parameter for the cloud_endpoints resource.
  - name: sync_group_name
    value: "{{ sync_group_name }}"
    description: Required parameter for the cloud_endpoints resource.
  - name: cloud_endpoint_name
    value: "{{ cloud_endpoint_name }}"
    description: Required parameter for the cloud_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cloud_endpoints resource.
  - name: properties
    value:
      storageAccountResourceId: "{{ storageAccountResourceId }}"
      azureFileShareName: "{{ azureFileShareName }}"
      storageAccountTenantId: "{{ storageAccountTenantId }}"
      friendlyName: "{{ friendlyName }}"

DELETE examples

delete

Delete a given CloudEndpoint.

DELETE FROM azure.storage_sync.cloud_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 cloud_endpoint_name = '{{ cloud_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

pre_backup

Pre Backup a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.pre_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@cloud_endpoint_name='{{ cloud_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureFileShare": "{{ azureFileShare }}"
}'
;

post_backup

Post Backup a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.post_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@cloud_endpoint_name='{{ cloud_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"azureFileShare": "{{ azureFileShare }}"
}'
;

pre_restore

Pre Restore a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.pre_restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@cloud_endpoint_name='{{ cloud_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@cloud_endpoint_name='{{ cloud_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

post_restore

Post Restore a given CloudEndpoint.

EXEC azure.storage_sync.cloud_endpoints.post_restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@cloud_endpoint_name='{{ cloud_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --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 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@sync_group_name='{{ sync_group_name }}' --required, 
@cloud_endpoint_name='{{ cloud_endpoint_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"directoryPath": "{{ directoryPath }}", 
"changeDetectionMode": "{{ changeDetectionMode }}", 
"paths": "{{ paths }}"
}'
;