configuration_services

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

Overview

Name	configuration_services
Type	Resource
Id	azure_extras.app_platform.configuration_services

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.
generation	string	The generation of the Application Configuration Service. Known values are: "Gen1" and "Gen2".
instances	array	Collection of instances belong to Application Configuration Service.
provisioningState	string	State of the Application Configuration Service. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
resourceRequests	object	The requested resource quantity for required CPU and Memory.
settings	object	The settings of Application Configuration Service.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	Fully qualified resource Id for the resource.
name	string	The name of the resource.
generation	string	The generation of the Application Configuration Service. Known values are: "Gen1" and "Gen2".
instances	array	Collection of instances belong to Application Configuration Service.
provisioningState	string	State of the Application Configuration Service. Known values are: "Creating", "Updating", "Succeeded", "Failed", and "Deleting".
resourceRequests	object	The requested resource quantity for required CPU and Memory.
settings	object	The settings of Application Configuration Service.
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, configuration_service_name, subscription_id		Get the Application Configuration Service and its properties.
list	select	resource_group_name, service_name, subscription_id		Handles requests to list all resources in a Service.
create_or_update	insert	resource_group_name, service_name, configuration_service_name, subscription_id		Create the default Application Configuration Service or update the existing Application Configuration Service.
create_or_update	replace	resource_group_name, service_name, configuration_service_name, subscription_id		Create the default Application Configuration Service or update the existing Application Configuration Service.
delete	delete	resource_group_name, service_name, configuration_service_name, subscription_id		Disable the default Application Configuration Service.
validate	exec	resource_group_name, service_name, configuration_service_name, subscription_id		Check if the Application Configuration Service settings are valid.
validate_resource	exec	resource_group_name, service_name, configuration_service_name, subscription_id		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
configuration_service_name	string	The name of Application Configuration Service. Required.
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 Application Configuration Service and its properties.

SELECT
id,
name,
generation,
instances,
provisioningState,
resourceRequests,
settings,
systemData,
type
FROM azure_extras.app_platform.configuration_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND configuration_service_name = '{{ configuration_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Handles requests to list all resources in a Service.

SELECT
id,
name,
generation,
instances,
provisioningState,
resourceRequests,
settings,
systemData,
type
FROM azure_extras.app_platform.configuration_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.app_platform.configuration_services (
properties,
resource_group_name,
service_name,
configuration_service_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ configuration_service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configuration_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configuration_services resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the configuration_services resource.
  - name: configuration_service_name
    value: "{{ configuration_service_name }}"
    description: Required parameter for the configuration_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configuration_services resource.
  - name: properties
    description: |
      Application Configuration Service properties payload.
    value:
      provisioningState: "{{ provisioningState }}"
      generation: "{{ generation }}"
      resourceRequests:
        cpu: "{{ cpu }}"
        memory: "{{ memory }}"
        instanceCount: {{ instanceCount }}
      instances:
        - name: "{{ name }}"
          status: "{{ status }}"
      settings:
        gitProperty:
          repositories:
            - name: "{{ name }}"
              patterns: "{{ patterns }}"
              uri: "{{ uri }}"
              label: "{{ label }}"
              searchPaths: "{{ searchPaths }}"
              username: "{{ username }}"
              password: "{{ password }}"
              hostKey: "{{ hostKey }}"
              hostKeyAlgorithm: "{{ hostKeyAlgorithm }}"
              privateKey: "{{ privateKey }}"
              strictHostKeyChecking: {{ strictHostKeyChecking }}
              gitImplementation: "{{ gitImplementation }}"
              caCertResourceId: "{{ caCertResourceId }}"

REPLACE examples

create_or_update

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

REPLACE azure_extras.app_platform.configuration_services
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND configuration_service_name = '{{ configuration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Disable the default Application Configuration Service.

DELETE FROM azure_extras.app_platform.configuration_services
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND configuration_service_name = '{{ configuration_service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

validate

Check if the Application Configuration Service settings are valid.

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

validate_resource

Check if the Application Configuration Service resource is valid.

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