fluid_relay_servers

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

Overview

Name	fluid_relay_servers
Type	Resource
Id	azure.fluid_relay.fluid_relay_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.
encryption	object	All encryption configuration for a resource.
fluidRelayEndpoints	object	The Fluid Relay Service endpoints for this server.
frsTenantId	string	The Fluid tenantId for this server.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provision states for FluidRelay RP. Known values are: "Succeeded", "Failed", and "Canceled".
storagesku	string	Sku of the storage associated with the resource. Known values are: "standard" and "basic".
systemData	object	System meta data for this resource, including creation and modification information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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.
encryption	object	All encryption configuration for a resource.
fluidRelayEndpoints	object	The Fluid Relay Service endpoints for this server.
frsTenantId	string	The Fluid tenantId for this server.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provision states for FluidRelay RP. Known values are: "Succeeded", "Failed", and "Canceled".
storagesku	string	Sku of the storage associated with the resource. Known values are: "standard" and "basic".
systemData	object	System meta data for this resource, including creation and modification information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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.
encryption	object	All encryption configuration for a resource.
fluidRelayEndpoints	object	The Fluid Relay Service endpoints for this server.
frsTenantId	string	The Fluid tenantId for this server.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provision states for FluidRelay RP. Known values are: "Succeeded", "Failed", and "Canceled".
storagesku	string	Sku of the storage associated with the resource. Known values are: "standard" and "basic".
systemData	object	System meta data for this resource, including creation and modification information.
tags	object	Resource tags.
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, fluid_relay_server_name, subscription_id		Get a Fluid Relay server. Get a Fluid Relay server.
list_by_resource_group	select	resource_group, subscription_id		List all Fluid Relay servers in a resource group. List all Fluid Relay servers in a resource group.
list_by_subscription	select	subscription_id		List all Fluid Relay servers in a subscription. List all Fluid Relay servers in a subscription.
create_or_update	insert	resource_group, fluid_relay_server_name, subscription_id, location		Create or Update a Fluid Relay server. Create or Update a Fluid Relay server.
update	update	resource_group, fluid_relay_server_name, subscription_id		Update a Fluid Relay server. Update a Fluid Relay server.
create_or_update	replace	resource_group, fluid_relay_server_name, subscription_id, location		Create or Update a Fluid Relay server. Create or Update a Fluid Relay server.
delete	delete	resource_group, fluid_relay_server_name, subscription_id		Delete a Fluid Relay server. Delete a Fluid Relay server.
list_keys	exec	resource_group, fluid_relay_server_name, subscription_id		Get primary and secondary key for this server. Get primary and secondary key for this server.
regenerate_key	exec	resource_group, fluid_relay_server_name, subscription_id, keyName		Regenerate the primary or secondary key for this server. Regenerate the primary or secondary key for this server.

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
fluid_relay_server_name	string	The Fluid Relay server resource name. Required.
resource_group	string	The resource group containing the resource. Required.
subscription_id	string

SELECT examples

get

Get a Fluid Relay server. Get a Fluid Relay server.

SELECT
id,
name,
encryption,
fluidRelayEndpoints,
frsTenantId,
identity,
location,
provisioningState,
storagesku,
systemData,
tags,
type
FROM azure.fluid_relay.fluid_relay_servers
WHERE resource_group = '{{ resource_group }}' -- required
AND fluid_relay_server_name = '{{ fluid_relay_server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all Fluid Relay servers in a resource group. List all Fluid Relay servers in a resource group.

SELECT
id,
name,
encryption,
fluidRelayEndpoints,
frsTenantId,
identity,
location,
provisioningState,
storagesku,
systemData,
tags,
type
FROM azure.fluid_relay.fluid_relay_servers
WHERE resource_group = '{{ resource_group }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all Fluid Relay servers in a subscription. List all Fluid Relay servers in a subscription.

SELECT
id,
name,
encryption,
fluidRelayEndpoints,
frsTenantId,
identity,
location,
provisioningState,
storagesku,
systemData,
tags,
type
FROM azure.fluid_relay.fluid_relay_servers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update a Fluid Relay server. Create or Update a Fluid Relay server.

INSERT INTO azure.fluid_relay.fluid_relay_servers (
tags,
location,
identity,
properties,
resource_group,
fluid_relay_server_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group }}',
'{{ fluid_relay_server_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: fluid_relay_servers
props:
  - name: resource_group
    value: "{{ resource_group }}"
    description: Required parameter for the fluid_relay_servers resource.
  - name: fluid_relay_server_name
    value: "{{ fluid_relay_server_name }}"
    description: Required parameter for the fluid_relay_servers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the fluid_relay_servers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The type of identity used for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      provisioningState: "{{ provisioningState }}"
      encryption:
        customerManagedKeyEncryption:
          keyEncryptionKeyIdentity:
            identityType: "{{ identityType }}"
            userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
          keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
      storagesku: "{{ storagesku }}"

UPDATE examples

update

Update a Fluid Relay server. Update a Fluid Relay server.

UPDATE azure.fluid_relay.fluid_relay_servers
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND fluid_relay_server_name = '{{ fluid_relay_server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or Update a Fluid Relay server. Create or Update a Fluid Relay server.

REPLACE azure.fluid_relay.fluid_relay_servers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group = '{{ resource_group }}' --required
AND fluid_relay_server_name = '{{ fluid_relay_server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Fluid Relay server. Delete a Fluid Relay server.

DELETE FROM azure.fluid_relay.fluid_relay_servers
WHERE resource_group = '{{ resource_group }}' --required
AND fluid_relay_server_name = '{{ fluid_relay_server_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_keys

Get primary and secondary key for this server. Get primary and secondary key for this server.

EXEC azure.fluid_relay.fluid_relay_servers.list_keys 
@resource_group='{{ resource_group }}' --required, 
@fluid_relay_server_name='{{ fluid_relay_server_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_key

Regenerate the primary or secondary key for this server. Regenerate the primary or secondary key for this server.

EXEC azure.fluid_relay.fluid_relay_servers.regenerate_key 
@resource_group='{{ resource_group }}' --required, 
@fluid_relay_server_name='{{ fluid_relay_server_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;