hybrid_connections

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

Overview

Name	hybrid_connections
Type	Resource
Id	azure.relay.hybrid_connections

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved description for the hybrid connection.

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

list_by_namespace

Request to retrieve hybrid connections by namespace succeeded.

Name	Datatype	Description
properties		Properties of the HybridConnection.
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, hybridConnectionName, subscriptionId		Returns the description for the specified hybrid connection.
list_by_namespace	select	resourceGroupName, namespaceName, subscriptionId		Lists the hybrid connection within the namespace.
create_or_update	insert	resourceGroupName, namespaceName, hybridConnectionName, subscriptionId		Creates or updates a service hybrid connection. This operation is idempotent.
delete	delete	resourceGroupName, namespaceName, hybridConnectionName, subscriptionId		Deletes a hybrid connection.
regenerate_keys	exec	resourceGroupName, namespaceName, hybridConnectionName, authorizationRuleName, subscriptionId, keyType		Regenerates the primary or secondary connection strings to the hybrid connection.

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.
hybridConnectionName	string	The hybrid connection name.
namespaceName	string	The namespace 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 hybrid connection.

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

list_by_namespace

Lists the hybrid connection within the namespace.

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

INSERT examples

create_or_update

Creates or updates a service hybrid connection. This operation is idempotent.

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

Manifest

# Description fields are for documentation purposes
- name: hybrid_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: namespaceName
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: hybridConnectionName
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: properties
      value: string
      description: |
        Properties of the HybridConnection.

DELETE examples

delete

Deletes a hybrid connection.

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

Lifecycle Methods

regenerate_keys

Regenerates the primary or secondary connection strings to the hybrid connection.

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