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

vw_cloud_endpoints

Name	Datatype	Description
azure_file_share_name	text	field from the properties object
backup_enabled	text	field from the properties object
change_enumeration_status	text	field from the properties object
cloudEndpointName	text	field from the properties object
friendly_name	text	field from the properties object
last_operation_name	text	field from the properties object
last_workflow_id	text	field from the properties object
partnership_id	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
storageSyncServiceName	text	field from the properties object
storage_account_resource_id	text	field from the properties object
storage_account_tenant_id	text	field from the properties object
subscriptionId	text	field from the properties object
syncGroupName	text	field from the properties object

cloud_endpoints

Name	Datatype	Description
properties	object	CloudEndpoint Properties object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Get a given CloudEndpoint.
list_by_sync_group	SELECT	resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Get a CloudEndpoint List.
create	INSERT	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Create a new CloudEndpoint.
delete	DELETE	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Delete a given CloudEndpoint.
afs_share_metadata_certificate_public_keys	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Get the AFS file share metadata signing certificate public keys.
post_backup	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Post Backup a given CloudEndpoint.
post_restore	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Post Restore a given CloudEndpoint.
pre_backup	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Pre Backup a given CloudEndpoint.
pre_restore	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Pre Restore a given CloudEndpoint.
restoreheartbeat	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Restore Heartbeat a given CloudEndpoint.
trigger_change_detection	EXEC	cloudEndpointName, resourceGroupName, storageSyncServiceName, subscriptionId, syncGroupName	Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.

SELECT examples

Get a CloudEndpoint List.

vw_cloud_endpoints

SELECT
azure_file_share_name,
backup_enabled,
change_enumeration_status,
cloudEndpointName,
friendly_name,
last_operation_name,
last_workflow_id,
partnership_id,
provisioning_state,
resourceGroupName,
storageSyncServiceName,
storage_account_resource_id,
storage_account_tenant_id,
subscriptionId,
syncGroupName
FROM azure.storage_sync.vw_cloud_endpoints
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND storageSyncServiceName = '{{ storageSyncServiceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND syncGroupName = '{{ syncGroupName }}';

cloud_endpoints

SELECT
properties
FROM azure.storage_sync.cloud_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 cloud_endpoints resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: storageAccountResourceId
          value: string
        - name: azureFileShareName
          value: string
        - name: storageAccountTenantId
          value: string
        - name: friendlyName
          value: string

DELETE example

Deletes the specified cloud_endpoints resource.

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