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

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.
port	integer	The port on which service is enabled.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Creating", "Updating", "Failed", and "Canceled". (Succeeded, Creating, Updating, Failed, Canceled)
resourceId	string	The resource Id of the connectivity endpoint (optional).
serviceName	string	Name of the service. Required. Known values are: "SSH" and "WAC". (SSH, WAC)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_endpoint_resource

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.
port	integer	The port on which service is enabled.
provisioningState	string	The resource provisioning state. Known values are: "Succeeded", "Creating", "Updating", "Failed", and "Canceled". (Succeeded, Creating, Updating, Failed, Canceled)
resourceId	string	The resource Id of the connectivity endpoint (optional).
serviceName	string	Name of the service. Required. Known values are: "SSH" and "WAC". (SSH, WAC)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_uri, endpoint_name, service_configuration_name		Gets the details about the service to the resource.
list_by_endpoint_resource	select	resource_uri, endpoint_name		Lists of all the services associated with endpoint resource. API to enumerate registered services in service configurations under a Endpoint Resource.
update	update	resource_uri, endpoint_name, service_configuration_name		Update the service details in the service configurations of the target resource.
delete	delete	resource_uri, endpoint_name, service_configuration_name		Deletes the service details to the target resource.
create_orupdate	exec	resource_uri, endpoint_name, service_configuration_name		Create or update a service in serviceConfiguration for the endpoint 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
endpoint_name	string	The endpoint name. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource. Required.
service_configuration_name	string	The service name. Required.

SELECT examples

get

Gets the details about the service to the resource.

SELECT
id,
name,
port,
provisioningState,
resourceId,
serviceName,
systemData,
type
FROM azure.hybrid_connectivity.service_configurations
WHERE resource_uri = '{{ resource_uri }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
AND service_configuration_name = '{{ service_configuration_name }}' -- required
;

list_by_endpoint_resource

Lists of all the services associated with endpoint resource. API to enumerate registered services in service configurations under a Endpoint Resource.

SELECT
id,
name,
port,
provisioningState,
resourceId,
serviceName,
systemData,
type
FROM azure.hybrid_connectivity.service_configurations
WHERE resource_uri = '{{ resource_uri }}' -- required
AND endpoint_name = '{{ endpoint_name }}' -- required
;

UPDATE examples

update

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

UPDATE azure.hybrid_connectivity.service_configurations
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND service_configuration_name = '{{ service_configuration_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the service details to the target resource.

DELETE FROM azure.hybrid_connectivity.service_configurations
WHERE resource_uri = '{{ resource_uri }}' --required
AND endpoint_name = '{{ endpoint_name }}' --required
AND service_configuration_name = '{{ service_configuration_name }}' --required
;

Lifecycle Methods

create_orupdate

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

EXEC azure.hybrid_connectivity.service_configurations.create_orupdate 
@resource_uri='{{ resource_uri }}' --required, 
@endpoint_name='{{ endpoint_name }}' --required, 
@service_configuration_name='{{ service_configuration_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;