service_configurations

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

Overview

Name	service_configurations
Type	Resource
Id	azure.hybrid_connectivity.service_configurations

Fields

The following fields are returned by SELECT queries:

get

Service configuration resource request was successful

Name	Datatype	Description
properties	object	The service configuration properties.
systemData	object	System data of endpoint resource

list_by_endpoint_resource

Name	Datatype	Description
properties	object	The service configuration properties.
systemData	object	System data of endpoint resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceUri, endpointName, serviceConfigurationName		Gets the details about the service to the resource.
list_by_endpoint_resource	select	resourceUri, endpointName		API to enumerate registered services in service configurations under a Endpoint Resource
create_orupdate	insert	resourceUri, endpointName, serviceConfigurationName		Create or update a service in serviceConfiguration for the endpoint resource.
update	update	resourceUri, endpointName, serviceConfigurationName		Update the service details in the service configurations of the target resource.
delete	delete	resourceUri, endpointName, serviceConfigurationName		Deletes the service details to the target resource.

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
endpointName	string	The endpoint name.
resourceUri	string	The fully qualified Azure Resource manager identifier of the resource to be connected.
serviceConfigurationName	string	The service name.

SELECT examples

get

Gets the details about the service to the resource.

SELECT
properties,
systemData
FROM azure.hybrid_connectivity.service_configurations
WHERE resourceUri = '{{ resourceUri }}' -- required
AND endpointName = '{{ endpointName }}' -- required
AND serviceConfigurationName = '{{ serviceConfigurationName }}' -- required
;

list_by_endpoint_resource

API to enumerate registered services in service configurations under a Endpoint Resource

SELECT
properties,
systemData
FROM azure.hybrid_connectivity.service_configurations
WHERE resourceUri = '{{ resourceUri }}' -- required
AND endpointName = '{{ endpointName }}' -- required
;

INSERT examples

create_orupdate

Create or update a service in serviceConfiguration for the endpoint resource.

INSERT INTO azure.hybrid_connectivity.service_configurations (
data__properties,
resourceUri,
endpointName,
serviceConfigurationName
)
SELECT 
'{{ properties }}',
'{{ resourceUri }}',
'{{ endpointName }}',
'{{ serviceConfigurationName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: service_configurations
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the service_configurations resource.
    - name: endpointName
      value: string
      description: Required parameter for the service_configurations resource.
    - name: serviceConfigurationName
      value: string
      description: Required parameter for the service_configurations resource.
    - name: properties
      value: object
      description: |
        The service configuration properties.

UPDATE examples

update

Update the service details in the service configurations of the target resource.

UPDATE azure.hybrid_connectivity.service_configurations
SET 
data__properties = '{{ properties }}'
WHERE 
resourceUri = '{{ resourceUri }}' --required
AND endpointName = '{{ endpointName }}' --required
AND serviceConfigurationName = '{{ serviceConfigurationName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Deletes the service details to the target resource.

DELETE FROM azure.hybrid_connectivity.service_configurations
WHERE resourceUri = '{{ resourceUri }}' --required
AND endpointName = '{{ endpointName }}' --required
AND serviceConfigurationName = '{{ serviceConfigurationName }}' --required
;