hybrid_connections

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

Overview

Name	hybrid_connections
Type	Resource
Id	azure.relay.hybrid_connections

Fields

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
location	string	The geo-location where the resource lives
properties	``	Properties of the HybridConnection.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hybridConnectionName, namespaceName, resourceGroupName, subscriptionId	Returns the description for the specified hybrid connection.
list_by_namespace	SELECT	namespaceName, resourceGroupName, subscriptionId	Lists the hybrid connection within the namespace.
create_or_update	INSERT	hybridConnectionName, namespaceName, resourceGroupName, subscriptionId	Creates or updates a service hybrid connection. This operation is idempotent.
delete	DELETE	hybridConnectionName, namespaceName, resourceGroupName, subscriptionId	Deletes a hybrid connection.
regenerate_keys	EXEC	authorizationRuleName, hybridConnectionName, namespaceName, resourceGroupName, subscriptionId, data__keyType	Regenerates the primary or secondary connection strings to the hybrid connection.

SELECT examples

Lists the hybrid connection within the namespace.

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure.relay.hybrid_connections
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new hybrid_connections resource.

All Properties

/*+ create */
INSERT INTO azure.relay.hybrid_connections (
hybridConnectionName,
namespaceName,
resourceGroupName,
subscriptionId,
properties
)
SELECT 
'{{ hybridConnectionName }}',
'{{ namespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string

DELETE example

Deletes the specified hybrid_connections resource.

/*+ delete */
DELETE FROM azure.relay.hybrid_connections
WHERE hybridConnectionName = '{{ hybridConnectionName }}'
AND namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';