configuration_services

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

Overview

Name	configuration_services
Type	Resource
Id	azure.spring_apps.configuration_services

Fields

The following fields are returned by SELECT queries:

get

Success. The response describes the corresponding Application Configuration Service.

Name	Datatype	Description
properties	object	Application Configuration Service properties payload

list

Success. The response describes the list of configuration service in the Service.

Name	Datatype	Description
properties	object	Application Configuration Service properties payload

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serviceName, configurationServiceName		Get the Application Configuration Service and its properties.
list	select	subscriptionId, resourceGroupName, serviceName		Handles requests to list all resources in a Service.
create_or_update	insert	subscriptionId, resourceGroupName, serviceName, configurationServiceName		Create the default Application Configuration Service or update the existing Application Configuration Service.
delete	delete	subscriptionId, resourceGroupName, serviceName, configurationServiceName		Disable the default Application Configuration Service.
validate	exec	subscriptionId, resourceGroupName, serviceName, configurationServiceName		Check if the Application Configuration Service settings are valid.
validate_resource	exec	subscriptionId, resourceGroupName, serviceName, configurationServiceName		Check if the Application Configuration Service resource is 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
configurationServiceName	string	The name of Application Configuration Service.
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 Application Configuration Service and its properties.

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

list

Handles requests to list all resources in a Service.

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

INSERT examples

create_or_update

Create the default Application Configuration Service or update the existing Application Configuration Service.

INSERT INTO azure.spring_apps.configuration_services (
data__properties,
subscriptionId,
resourceGroupName,
serviceName,
configurationServiceName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ configurationServiceName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: configuration_services
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the configuration_services resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configuration_services resource.
    - name: serviceName
      value: string
      description: Required parameter for the configuration_services resource.
    - name: configurationServiceName
      value: string
      description: Required parameter for the configuration_services resource.
    - name: properties
      value: object
      description: |
        Application Configuration Service properties payload

DELETE examples

delete

Disable the default Application Configuration Service.

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

Lifecycle Methods

validate

Check if the Application Configuration Service settings are valid.

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

validate_resource

Check if the Application Configuration Service resource is valid.

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