relay_service_connections

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

Overview

Name	relay_service_connections
Type	Resource
Id	azure.app_service.relay_service_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	RelayServiceConnectionEntity 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	RelayServiceConnectionEntity 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, entityName, subscriptionId		Description for Gets a hybrid connection configuration by its name.
list	select	resourceGroupName, name, subscriptionId		Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
create_or_update	insert	resourceGroupName, name, entityName, subscriptionId		Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
update	update	resourceGroupName, name, entityName, subscriptionId		Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
delete	delete	resourceGroupName, name, entityName, subscriptionId		Description for Deletes a relay service connection by its name.

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
entityName	string	Name of the hybrid connection configuration.
name	string	Name of the app.
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 Gets a hybrid connection configuration by its name.

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

list

Description for Gets hybrid connections configured for an app (or deployment slot, if specified).

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.relay_service_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 configuration (PUT), or updates an existing one (PATCH).

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

Manifest

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

UPDATE examples

update

Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).

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

DELETE examples

delete

Description for Deletes a relay service connection by its name.

DELETE FROM azure.app_service.relay_service_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND entityName = '{{ entityName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;