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

Registered Server resources in Sync Group

Name	Datatype	Description
properties	object	RegisteredServer properties.

list_by_storage_sync_service

Array of Registered Server resources in Storage Sync Service

Name	Datatype	Description
properties	object	RegisteredServer properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, storageSyncServiceName, serverId		Get a given registered server.
list_by_storage_sync_service	select	subscriptionId, resourceGroupName, storageSyncServiceName		Get a given registered server list.
create	insert	subscriptionId, resourceGroupName, storageSyncServiceName, serverId		Add a new registered server.
update	update	subscriptionId, resourceGroupName, storageSyncServiceName, serverId		Update registered server.
delete	delete	subscriptionId, resourceGroupName, storageSyncServiceName, serverId		Delete the given registered server.
trigger_rollover	exec	subscriptionId, resourceGroupName, storageSyncServiceName, serverId		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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverId	string	Server Id
storageSyncServiceName	string	Name of Storage Sync Service resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a given registered server.

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

list_by_storage_sync_service

Get a given registered server list.

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

INSERT examples

create

Add a new registered server.

INSERT INTO azure.storage_sync.registered_servers (
data__properties,
subscriptionId,
resourceGroupName,
storageSyncServiceName,
serverId
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageSyncServiceName }}',
'{{ serverId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: registered_servers
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the registered_servers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the registered_servers resource.
    - name: storageSyncServiceName
      value: string
      description: Required parameter for the registered_servers resource.
    - name: serverId
      value: string
      description: Required parameter for the registered_servers resource.
    - name: properties
      value: object
      description: |
        The parameters used to create the registered server.

UPDATE examples

update

Update registered server.

UPDATE azure.storage_sync.registered_servers
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' --required
AND serverId = '{{ serverId }}' --required
RETURNING
properties;

DELETE examples

delete

Delete the given registered server.

DELETE FROM azure.storage_sync.registered_servers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' --required
AND serverId = '{{ serverId }}' --required
;

Lifecycle Methods

trigger_rollover

Triggers Server certificate rollover.

EXEC azure.storage_sync.registered_servers.trigger_rollover 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@storageSyncServiceName='{{ storageSyncServiceName }}' --required, 
@serverId='{{ serverId }}' --required 
@@json=
'{
"serverCertificate": "{{ serverCertificate }}"
}'
;