hybrid_connections

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

Overview

Name	hybrid_connections
Type	Resource
Id	azure.app_service.hybrid_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	HybridConnection resource specific properties
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	HybridConnection resource specific properties
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, namespaceName, relayName, subscriptionId		Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
list	select	resourceGroupName, name, subscriptionId		Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
create_or_update	insert	resourceGroupName, name, namespaceName, relayName, subscriptionId		Description for Creates a new Hybrid Connection using a Service Bus relay.
update	update	resourceGroupName, name, namespaceName, relayName, subscriptionId		Description for Creates a new Hybrid Connection using a Service Bus relay.
delete	delete	resourceGroupName, name, namespaceName, relayName, subscriptionId		Description for Removes a Hybrid Connection from this site.

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
name	string	The name of the web app.
namespaceName	string	The namespace for this hybrid connection.
relayName	string	The relay name for this hybrid connection.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

SELECT examples

get

Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.hybrid_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND relayName = '{{ relayName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Description for Retrieves all Service Bus Hybrid Connections used by this Web App.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.hybrid_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Creates a new Hybrid Connection using a Service Bus relay.

INSERT INTO azure.app_service.hybrid_connections (
data__kind,
data__properties,
resourceGroupName,
name,
namespaceName,
relayName,
subscriptionId
)
SELECT 
'{{ kind }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ namespaceName }}',
'{{ relayName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: hybrid_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: name
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: namespaceName
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: relayName
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the hybrid_connections resource.
    - name: kind
      value: string
      description: |
        Kind of resource.
    - name: properties
      value: object
      description: |
        HybridConnection resource specific properties

UPDATE examples

update

Description for Creates a new Hybrid Connection using a Service Bus relay.

UPDATE azure.app_service.hybrid_connections
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND relayName = '{{ relayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
kind,
properties,
type;

DELETE examples

delete

Description for Removes a Hybrid Connection from this site.

DELETE FROM azure.app_service.hybrid_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND relayName = '{{ relayName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;