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:

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 hybrid connection was created.
listenerCount	integer	The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
requiresClientAuthorization	boolean	Returns true if client authorization is needed for this hybrid connection; 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 hybrid connection endpoint. For example, it can be used to store descriptive data, such as a 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 hybrid connection was created.
listenerCount	integer	The number of listeners for this hybrid connection. Note that min : 1 and max:25 are supported.
requiresClientAuthorization	boolean	Returns true if client authorization is needed for this hybrid connection; 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 hybrid connection endpoint. For example, it can be used to store descriptive data, such as a 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, hybrid_connection_name, authorization_rule_name, subscription_id		Primary and secondary connection strings to the hybrid connection.
get	select	resource_group_name, namespace_name, hybrid_connection_name, subscription_id		Returns the description for the specified hybrid connection.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id		Lists the hybrid connection within the namespace.
create_or_update	insert	resource_group_name, namespace_name, hybrid_connection_name, subscription_id		Creates or updates a service hybrid connection. This operation is idempotent.
create_or_update	replace	resource_group_name, namespace_name, hybrid_connection_name, subscription_id		Creates or updates a service hybrid connection. This operation is idempotent.
delete	delete	resource_group_name, namespace_name, hybrid_connection_name, subscription_id		Deletes a hybrid connection.
list_authorization_rules	exec	resource_group_name, namespace_name, hybrid_connection_name, subscription_id		Authorization rules for a hybrid connection.
get_authorization_rule	exec	resource_group_name, namespace_name, hybrid_connection_name, authorization_rule_name, subscription_id		Hybrid connection authorization rule for a hybrid connection by name.
create_or_update_authorization_rule	exec	resource_group_name, namespace_name, hybrid_connection_name, authorization_rule_name, subscription_id, properties		Creates or updates an authorization rule for a hybrid connection.
delete_authorization_rule	exec	resource_group_name, namespace_name, hybrid_connection_name, authorization_rule_name, subscription_id		Deletes a hybrid connection authorization rule.
regenerate_keys	exec	resource_group_name, namespace_name, hybrid_connection_name, authorization_rule_name, subscription_id, 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
authorization_rule_name	string	The authorization rule name. Required.
hybrid_connection_name	string	The hybrid connection name. Required.
namespace_name	string	The namespace 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 hybrid connection.

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

get

Returns the description for the specified hybrid connection.

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

list_by_namespace

Lists the hybrid connection within the namespace.

SELECT
id,
name,
createdAt,
listenerCount,
requiresClientAuthorization,
type,
updatedAt,
userMetadata
FROM azure.relay.hybrid_connections
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 service hybrid connection. This operation is idempotent.

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

Manifest

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

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Deletes a hybrid connection.

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

Lifecycle Methods

list_authorization_rules

Authorization rules for a hybrid connection.

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

get_authorization_rule

Hybrid connection authorization rule for a hybrid connection by name.

EXEC azure.relay.hybrid_connections.get_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@hybrid_connection_name='{{ hybrid_connection_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 hybrid connection.

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

delete_authorization_rule

Deletes a hybrid connection authorization rule.

EXEC azure.relay.hybrid_connections.delete_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@hybrid_connection_name='{{ hybrid_connection_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 hybrid connection.

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