servers

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

Overview

Name	servers
Type	Resource
Id	azure.fluid_relay.servers

Fields

The following fields are returned by SELECT queries:

get

Request completed synchronously.

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
systemData	object	System meta data for this resource, including creation and modification information.
tags	object	Resource tags.

list_by_resource_group

Paged response

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
systemData	object	System meta data for this resource, including creation and modification information.
tags	object	Resource tags.

list_by_subscription

Paged response

Name	Datatype	Description
identity	object	Identity for the resource.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
systemData	object	System meta data for this resource, including creation and modification information.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroup, fluidRelayServerName
list_by_resource_group	select	subscriptionId, resourceGroup
list_by_subscription	select	subscriptionId
create_or_update	insert	subscriptionId, resourceGroup, fluidRelayServerName
update	update	subscriptionId, resourceGroup, fluidRelayServerName
delete	delete	subscriptionId, resourceGroup, fluidRelayServerName
regenerate_key	exec	subscriptionId, resourceGroup, fluidRelayServerName, keyName

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
fluidRelayServerName	string	The Fluid Relay server resource name.
resourceGroup	string	The resource group containing the resource.
subscriptionId	string	The subscription id (GUID) for this resource.

SELECT examples

get

Request completed synchronously.

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.fluid_relay.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
AND fluidRelayServerName = '{{ fluidRelayServerName }}' -- required
;

list_by_resource_group

Paged response

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.fluid_relay.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroup = '{{ resourceGroup }}' -- required
;

list_by_subscription

Paged response

SELECT
identity,
location,
properties,
systemData,
tags
FROM azure.fluid_relay.servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure.fluid_relay.servers (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroup,
fluidRelayServerName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroup }}',
'{{ fluidRelayServerName }}'
RETURNING
identity,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: servers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the servers resource.
    - name: resourceGroup
      value: string
      description: Required parameter for the servers resource.
    - name: fluidRelayServerName
      value: string
      description: Required parameter for the servers resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: identity
      value: object
      description: |
        Identity for the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

No description available.

UPDATE azure.fluid_relay.servers
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__identity = '{{ identity }}',
data__location = '{{ location }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroup = '{{ resourceGroup }}' --required
AND fluidRelayServerName = '{{ fluidRelayServerName }}' --required
RETURNING
identity,
location,
properties,
systemData,
tags;

DELETE examples

delete

No description available.

DELETE FROM azure.fluid_relay.servers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroup = '{{ resourceGroup }}' --required
AND fluidRelayServerName = '{{ fluidRelayServerName }}' --required
;

Lifecycle Methods

regenerate_key

Request Completed Synchronously.

EXEC azure.fluid_relay.servers.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroup='{{ resourceGroup }}' --required, 
@fluidRelayServerName='{{ fluidRelayServerName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;