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

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.
agentVersion	string	Registered Server Agent Version.
agentVersionExpirationDate	string (date-time)	Registered Server Agent Version Expiration Date.
agentVersionStatus	string	Registered Server Agent Version Status. Known values are: "Ok", "NearExpiry", "Expired", and "Blocked".
clusterId	string	Registered Server clusterId.
clusterName	string	Registered Server clusterName.
discoveryEndpointUri	string	Resource discoveryEndpointUri.
friendlyName	string	Friendly Name.
lastHeartBeat	string	Registered Server last heart beat.
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	Registered Server lastWorkflowId.
managementEndpointUri	string	Management Endpoint Uri.
monitoringConfiguration	string	Monitoring Configuration.
monitoringEndpointUri	string	Telemetry Endpoint Uri.
provisioningState	string	Registered Server Provisioning State.
resourceLocation	string	Resource Location.
serverCertificate	string	Registered Server Certificate.
serverId	string	Registered Server serverId.
serverManagementErrorCode	integer	Registered Server Management Error Code.
serverName	string	Server name.
serverOSVersion	string	Registered Server OS Version.
serverRole	string	Registered Server serverRole.
serviceLocation	string	Service Location.
storageSyncServiceUid	string	Registered Server storageSyncServiceUid.
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_storage_sync_service

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.
agentVersion	string	Registered Server Agent Version.
agentVersionExpirationDate	string (date-time)	Registered Server Agent Version Expiration Date.
agentVersionStatus	string	Registered Server Agent Version Status. Known values are: "Ok", "NearExpiry", "Expired", and "Blocked".
clusterId	string	Registered Server clusterId.
clusterName	string	Registered Server clusterName.
discoveryEndpointUri	string	Resource discoveryEndpointUri.
friendlyName	string	Friendly Name.
lastHeartBeat	string	Registered Server last heart beat.
lastOperationName	string	Resource Last Operation Name.
lastWorkflowId	string	Registered Server lastWorkflowId.
managementEndpointUri	string	Management Endpoint Uri.
monitoringConfiguration	string	Monitoring Configuration.
monitoringEndpointUri	string	Telemetry Endpoint Uri.
provisioningState	string	Registered Server Provisioning State.
resourceLocation	string	Resource Location.
serverCertificate	string	Registered Server Certificate.
serverId	string	Registered Server serverId.
serverManagementErrorCode	integer	Registered Server Management Error Code.
serverName	string	Server name.
serverOSVersion	string	Registered Server OS Version.
serverRole	string	Registered Server serverRole.
serviceLocation	string	Service Location.
storageSyncServiceUid	string	Registered Server storageSyncServiceUid.
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, server_id, subscription_id		Get a given registered server.
list_by_storage_sync_service	select	resource_group_name, storage_sync_service_name, subscription_id		Get a given registered server list.
create	insert	resource_group_name, storage_sync_service_name, server_id, subscription_id		Add a new registered server.
delete	delete	resource_group_name, storage_sync_service_name, server_id, subscription_id		Delete the given registered server.
trigger_rollover	exec	resource_group_name, storage_sync_service_name, server_id, subscription_id		Triggers Server certificate rollover.

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_id	string	Server Id. Required.
storage_sync_service_name	string	Name of Storage Sync Service resource. Required.
subscription_id	string

SELECT examples

get

Get a given registered server.

SELECT
id,
name,
agentVersion,
agentVersionExpirationDate,
agentVersionStatus,
clusterId,
clusterName,
discoveryEndpointUri,
friendlyName,
lastHeartBeat,
lastOperationName,
lastWorkflowId,
managementEndpointUri,
monitoringConfiguration,
monitoringEndpointUri,
provisioningState,
resourceLocation,
serverCertificate,
serverId,
serverManagementErrorCode,
serverName,
serverOSVersion,
serverRole,
serviceLocation,
storageSyncServiceUid,
systemData,
type
FROM azure.storage_sync.registered_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND server_id = '{{ server_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_storage_sync_service

Get a given registered server list.

SELECT
id,
name,
agentVersion,
agentVersionExpirationDate,
agentVersionStatus,
clusterId,
clusterName,
discoveryEndpointUri,
friendlyName,
lastHeartBeat,
lastOperationName,
lastWorkflowId,
managementEndpointUri,
monitoringConfiguration,
monitoringEndpointUri,
provisioningState,
resourceLocation,
serverCertificate,
serverId,
serverManagementErrorCode,
serverName,
serverOSVersion,
serverRole,
serviceLocation,
storageSyncServiceUid,
systemData,
type
FROM azure.storage_sync.registered_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Add a new registered server.

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

Manifest

# Description fields are for documentation purposes
- name: registered_servers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the registered_servers resource.
  - name: storage_sync_service_name
    value: "{{ storage_sync_service_name }}"
    description: Required parameter for the registered_servers resource.
  - name: server_id
    value: "{{ server_id }}"
    description: Required parameter for the registered_servers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the registered_servers resource.
  - name: properties
    value:
      serverCertificate: "{{ serverCertificate }}"
      agentVersion: "{{ agentVersion }}"
      serverOSVersion: "{{ serverOSVersion }}"
      lastHeartBeat: "{{ lastHeartBeat }}"
      serverRole: "{{ serverRole }}"
      clusterId: "{{ clusterId }}"
      clusterName: "{{ clusterName }}"
      serverId: "{{ serverId }}"
      friendlyName: "{{ friendlyName }}"

DELETE examples

delete

Delete the given registered server.

DELETE FROM azure.storage_sync.registered_servers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' --required
AND server_id = '{{ server_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

trigger_rollover

Triggers Server certificate rollover.

EXEC azure.storage_sync.registered_servers.trigger_rollover 
@resource_group_name='{{ resource_group_name }}' --required, 
@storage_sync_service_name='{{ storage_sync_service_name }}' --required, 
@server_id='{{ server_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"serverCertificate": "{{ serverCertificate }}"
}'
;