config_servers

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

Overview

Name	config_servers
Type	Resource
Id	azure_extras.app_platform.config_servers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
configServer	object	Settings of config server.
error	object	Error when apply config server settings.
provisioningState	string	State of the config server. Known values are: "NotAvailable", "Deleted", "Failed", "Succeeded", and "Updating".
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, subscription_id		Get the config server and its properties.
update_put	exec	resource_group_name, service_name, subscription_id		Update the config server.
update_patch	exec	resource_group_name, service_name, subscription_id		Update the config server.
validate	exec	resource_group_name, service_name, subscription_id		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
resource_group_name	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. Required.
service_name	string	The name of the Service resource. Required.
subscription_id	string

SELECT examples

get

Get the config server and its properties.

SELECT
id,
name,
configServer,
error,
provisioningState,
systemData,
type
FROM azure_extras.app_platform.config_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

update_put

Update the config server.

EXEC azure_extras.app_platform.config_servers.update_put 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_patch

Update the config server.

EXEC azure_extras.app_platform.config_servers.update_patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

validate

Check if the config server settings are valid.

EXEC azure_extras.app_platform.config_servers.validate 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"gitProperty": "{{ gitProperty }}"
}'
;