config_servers

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

Overview

Name	config_servers
Type	Resource
Id	azure.spring_apps.config_servers

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Config Server.

Name	Datatype	Description
properties	object	Properties of the Config Server resource

list

Success. The response describes the list of config servers in the Service.

Name	Datatype	Description
properties	object	Properties of the Config Server resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName		Get the config server and its properties.
list	select	subscriptionId, resourceGroupName, serviceName		Handles requests to list all config server resources in a Service.
delete	delete	subscriptionId, resourceGroupName, serviceName		Disable the default Config Server, only available in Enterprise Plan.
update_put	exec	subscriptionId, resourceGroupName, serviceName		Update the config server.
update_patch	exec	subscriptionId, resourceGroupName, serviceName		Update the config server.
validate	exec	subscriptionId, resourceGroupName, serviceName		Check if the config server settings are valid.

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
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serviceName	string	The name of the Service resource.
subscriptionId	string	Gets subscription ID which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Get the config server and its properties.

SELECT
properties
FROM azure.spring_apps.config_servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

list

Handles requests to list all config server resources in a Service.

SELECT
properties
FROM azure.spring_apps.config_servers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
;

DELETE examples

delete

Disable the default Config Server, only available in Enterprise Plan.

DELETE FROM azure.spring_apps.config_servers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
;

Lifecycle Methods

update_put

Update the config server.

EXEC azure.spring_apps.config_servers.update_put 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_patch

Update the config server.

EXEC azure.spring_apps.config_servers.update_patch 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

validate

Check if the config server settings are valid.

EXEC azure.spring_apps.config_servers.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"gitProperty": "{{ gitProperty }}"
}'
;