wcf_relays

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

Overview

Name	wcf_relays
Type	Resource
Id	azure.relay.wcf_relays

Fields

The following fields are returned by SELECT queries:

list_keys

Name	Datatype	Description
keyName	string	A string that describes the authorization rule.
primaryConnectionString	string	Primary connection string of the created namespace authorization rule.
primaryKey	string	A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondaryConnectionString	string	Secondary connection string of the created namespace authorization rule.
secondaryKey	string	A base64-encoded 256-bit secondary key for signing and validating the SAS token.

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
createdAt	string (date-time)	The time the WCF relay was created.
isDynamic	boolean	Returns true if the relay is dynamic; otherwise, false.
listenerCount	integer	The number of listeners for this relay. Note that min :1 and max:25 are supported.
relayType	string	WCF relay type. Known values are: "NetTcp" and "Http".
requiresClientAuthorization	boolean	Returns true if client authorization is needed for this relay; otherwise, false.
requiresTransportSecurity	boolean	Returns true if transport security is needed for this relay; otherwise, false.
type	string	Resource type.
updatedAt	string (date-time)	The time the namespace was updated.
userMetadata	string	The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

list_by_namespace

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
createdAt	string (date-time)	The time the WCF relay was created.
isDynamic	boolean	Returns true if the relay is dynamic; otherwise, false.
listenerCount	integer	The number of listeners for this relay. Note that min :1 and max:25 are supported.
relayType	string	WCF relay type. Known values are: "NetTcp" and "Http".
requiresClientAuthorization	boolean	Returns true if client authorization is needed for this relay; otherwise, false.
requiresTransportSecurity	boolean	Returns true if transport security is needed for this relay; otherwise, false.
type	string	Resource type.
updatedAt	string (date-time)	The time the namespace was updated.
userMetadata	string	The usermetadata is a placeholder to store user-defined string data for the WCF Relay endpoint. For example, it can be used to store descriptive data, such as list of teams and their contact information. Also, user-defined configuration settings can be stored.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_keys	select	resource_group_name, namespace_name, relay_name, authorization_rule_name, subscription_id		Primary and secondary connection strings to the WCF relay.
get	select	resource_group_name, namespace_name, relay_name, subscription_id		Returns the description for the specified WCF relay.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id		Lists the WCF relays within the namespace.
create_or_update	insert	resource_group_name, namespace_name, relay_name, subscription_id		Creates or updates a WCF relay. This operation is idempotent.
create_or_update	replace	resource_group_name, namespace_name, relay_name, subscription_id		Creates or updates a WCF relay. This operation is idempotent.
delete	delete	resource_group_name, namespace_name, relay_name, subscription_id		Deletes a WCF relay.
list_authorization_rules	exec	resource_group_name, namespace_name, relay_name, subscription_id		Authorization rules for a WCF relay.
get_authorization_rule	exec	resource_group_name, namespace_name, relay_name, authorization_rule_name, subscription_id		Get authorizationRule for a WCF relay by name.
create_or_update_authorization_rule	exec	resource_group_name, namespace_name, relay_name, authorization_rule_name, subscription_id, properties		Creates or updates an authorization rule for a WCF relay.
delete_authorization_rule	exec	resource_group_name, namespace_name, relay_name, authorization_rule_name, subscription_id		Deletes a WCF relay authorization rule.
regenerate_keys	exec	resource_group_name, namespace_name, relay_name, authorization_rule_name, subscription_id, keyType		Regenerates the primary or secondary connection strings to the WCF relay.

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
authorization_rule_name	string	The authorization rule name. Required.
namespace_name	string	The namespace name. Required.
relay_name	string	The relay name. Required.
resource_group_name	string	Name of the Resource group within the Azure subscription. Required.
subscription_id	string

SELECT examples

list_keys

Primary and secondary connection strings to the WCF relay.

SELECT
keyName,
primaryConnectionString,
primaryKey,
secondaryConnectionString,
secondaryKey
FROM azure.relay.wcf_relays
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND relay_name = '{{ relay_name }}' -- required
AND authorization_rule_name = '{{ authorization_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns the description for the specified WCF relay.

SELECT
id,
name,
createdAt,
isDynamic,
listenerCount,
relayType,
requiresClientAuthorization,
requiresTransportSecurity,
type,
updatedAt,
userMetadata
FROM azure.relay.wcf_relays
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND relay_name = '{{ relay_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_namespace

Lists the WCF relays within the namespace.

SELECT
id,
name,
createdAt,
isDynamic,
listenerCount,
relayType,
requiresClientAuthorization,
requiresTransportSecurity,
type,
updatedAt,
userMetadata
FROM azure.relay.wcf_relays
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a WCF relay. This operation is idempotent.

INSERT INTO azure.relay.wcf_relays (
properties,
resource_group_name,
namespace_name,
relay_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ relay_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: wcf_relays
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the wcf_relays resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the wcf_relays resource.
  - name: relay_name
    value: "{{ relay_name }}"
    description: Required parameter for the wcf_relays resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the wcf_relays resource.
  - name: properties
    value:
      relayType: "{{ relayType }}"
      requiresClientAuthorization: {{ requiresClientAuthorization }}
      requiresTransportSecurity: {{ requiresTransportSecurity }}
      userMetadata: "{{ userMetadata }}"

REPLACE examples

create_or_update

Creates or updates a WCF relay. This operation is idempotent.

REPLACE azure.relay.wcf_relays
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND relay_name = '{{ relay_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a WCF relay.

DELETE FROM azure.relay.wcf_relays
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND relay_name = '{{ relay_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_authorization_rules

Authorization rules for a WCF relay.

EXEC azure.relay.wcf_relays.list_authorization_rules 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@relay_name='{{ relay_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_authorization_rule

Get authorizationRule for a WCF relay by name.

EXEC azure.relay.wcf_relays.get_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@relay_name='{{ relay_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_authorization_rule

Creates or updates an authorization rule for a WCF relay.

EXEC azure.relay.wcf_relays.create_or_update_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@relay_name='{{ relay_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_authorization_rule

Deletes a WCF relay authorization rule.

EXEC azure.relay.wcf_relays.delete_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@relay_name='{{ relay_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_keys

Regenerates the primary or secondary connection strings to the WCF relay.

EXEC azure.relay.wcf_relays.regenerate_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@relay_name='{{ relay_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"key": "{{ key }}"
}'
;