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:

get

Successfully retrieved WCF relay description.

Name	Datatype	Description
properties		Properties of the WCF relay.
systemData	object	The system meta data relating to this resource.

list_by_namespace

WCF relays returned successfully.

Name	Datatype	Description
properties		Properties of the WCF relay.
systemData	object	The system meta data relating to this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, relayName, subscriptionId		Returns the description for the specified WCF relay.
list_by_namespace	select	resourceGroupName, namespaceName, subscriptionId		Lists the WCF relays within the namespace.
create_or_update	insert	resourceGroupName, namespaceName, relayName, subscriptionId		Creates or updates a WCF relay. This operation is idempotent.
delete	delete	resourceGroupName, namespaceName, relayName, subscriptionId		Deletes a WCF relay.
regenerate_keys	exec	resourceGroupName, namespaceName, relayName, authorizationRuleName, subscriptionId, 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
authorizationRuleName	string	The authorization rule name.
namespaceName	string	The namespace name
relayName	string	The relay name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns the description for the specified WCF relay.

SELECT
properties,
systemData
FROM azure.relay.wcf_relays
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND relayName = '{{ relayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_namespace

Lists the WCF relays within the namespace.

SELECT
properties,
systemData
FROM azure.relay.wcf_relays
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.relay.wcf_relays (
data__properties,
resourceGroupName,
namespaceName,
relayName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ relayName }}',
'{{ subscriptionId }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: wcf_relays
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the wcf_relays resource.
    - name: namespaceName
      value: string
      description: Required parameter for the wcf_relays resource.
    - name: relayName
      value: string
      description: Required parameter for the wcf_relays resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the wcf_relays resource.
    - name: properties
      value: string
      description: |
        Properties of the WCF relay.

DELETE examples

delete

Deletes a WCF relay.

DELETE FROM azure.relay.wcf_relays
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND relayName = '{{ relayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

regenerate_keys

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

EXEC azure.relay.wcf_relays.regenerate_keys 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@relayName='{{ relayName }}' --required, 
@authorizationRuleName='{{ authorizationRuleName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"key": "{{ key }}"
}'
;