registered_servers

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

Overview

Name	registered_servers
Type	Resource
Id	azure.storage_sync.registered_servers

Fields

vw_registered_servers

Name	Datatype	Description
active_auth_type	text	field from the properties object
agent_version	text	field from the properties object
agent_version_expiration_date	text	field from the properties object
agent_version_status	text	field from the properties object
application_id	text	field from the properties object
cluster_id	text	field from the properties object
cluster_name	text	field from the properties object
discovery_endpoint_uri	text	field from the properties object
friendly_name	text	field from the properties object
identity	text	field from the properties object
last_heart_beat	text	field from the properties object
last_operation_name	text	field from the properties object
last_workflow_id	text	field from the properties object
latest_application_id	text	field from the properties object
management_endpoint_uri	text	field from the properties object
monitoring_configuration	text	field from the properties object
monitoring_endpoint_uri	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_location	text	field from the properties object
serverId	text	field from the properties object
server_certificate	text	field from the properties object
server_id	text	field from the properties object
server_management_error_code	text	field from the properties object
server_name	text	field from the properties object
server_os_version	text	field from the properties object
server_role	text	field from the properties object
service_location	text	field from the properties object
storageSyncServiceName	text	field from the properties object
storage_sync_service_uid	text	field from the properties object
subscriptionId	text	field from the properties object

registered_servers

Name	Datatype	Description
properties	object	RegisteredServer Properties object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serverId, storageSyncServiceName, subscriptionId	Get a given registered server.
list_by_storage_sync_service	SELECT	resourceGroupName, storageSyncServiceName, subscriptionId	Get a given registered server list.
create	INSERT	resourceGroupName, serverId, storageSyncServiceName, subscriptionId	Add a new registered server.
delete	DELETE	resourceGroupName, serverId, storageSyncServiceName, subscriptionId	Delete the given registered server.
update	UPDATE	resourceGroupName, serverId, storageSyncServiceName, subscriptionId	Update registered server.
trigger_rollover	EXEC	resourceGroupName, serverId, storageSyncServiceName, subscriptionId	Triggers Server certificate rollover.

SELECT examples

Get a given registered server list.

vw_registered_servers

SELECT
active_auth_type,
agent_version,
agent_version_expiration_date,
agent_version_status,
application_id,
cluster_id,
cluster_name,
discovery_endpoint_uri,
friendly_name,
identity,
last_heart_beat,
last_operation_name,
last_workflow_id,
latest_application_id,
management_endpoint_uri,
monitoring_configuration,
monitoring_endpoint_uri,
provisioning_state,
resourceGroupName,
resource_location,
serverId,
server_certificate,
server_id,
server_management_error_code,
server_name,
server_os_version,
server_role,
service_location,
storageSyncServiceName,
storage_sync_service_uid,
subscriptionId
FROM azure.storage_sync.vw_registered_servers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND storageSyncServiceName = '{{ storageSyncServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';

registered_servers

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: serverCertificate
          value: string
        - name: agentVersion
          value: string
        - name: serverOSVersion
          value: string
        - name: lastHeartBeat
          value: string
        - name: serverRole
          value: string
        - name: clusterId
          value: string
        - name: clusterName
          value: string
        - name: serverId
          value: string
        - name: friendlyName
          value: string
        - name: applicationId
          value: string
        - name: identity
          value: boolean

UPDATE example

Updates a registered_servers resource.

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

DELETE example

Deletes the specified registered_servers resource.

/*+ delete */
DELETE FROM azure.storage_sync.registered_servers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverId = '{{ serverId }}'
AND storageSyncServiceName = '{{ storageSyncServiceName }}'
AND subscriptionId = '{{ subscriptionId }}';