configurations

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

Overview

Name	configurations
Type	Resource
Id	azure_isv.nginx.configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
name	string
location	string
properties	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string

list

Name	Datatype	Description
id	string
name	string
location	string
properties	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, deploymentName, configurationName
list	select	subscriptionId, resourceGroupName, deploymentName
create_or_update	insert	subscriptionId, resourceGroupName, deploymentName, configurationName
delete	delete	subscriptionId, resourceGroupName, deploymentName, configurationName
analysis	exec	subscriptionId, resourceGroupName, deploymentName, configurationName, config

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
configurationName	string	The name of configuration, only 'default' is supported value due to the singleton of NGINX conf
deploymentName	string	The name of targeted NGINX deployment
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Success

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure_isv.nginx.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND deploymentName = '{{ deploymentName }}' -- required
AND configurationName = '{{ configurationName }}' -- required
;

list

Success

SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure_isv.nginx.configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND deploymentName = '{{ deploymentName }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure_isv.nginx.configurations (
data__properties,
data__location,
subscriptionId,
resourceGroupName,
deploymentName,
configurationName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ deploymentName }}',
'{{ configurationName }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the configurations resource.
    - name: deploymentName
      value: string
      description: Required parameter for the configurations resource.
    - name: configurationName
      value: string
      description: Required parameter for the configurations resource.
    - name: properties
      value: object
    - name: location
      value: string

DELETE examples

delete

No description available.

DELETE FROM azure_isv.nginx.configurations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
AND configurationName = '{{ configurationName }}' --required
;

Lifecycle Methods

analysis

Analysis complete

EXEC azure_isv.nginx.configurations.analysis 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@deploymentName='{{ deploymentName }}' --required, 
@configurationName='{{ configurationName }}' --required 
@@json=
'{
"config": "{{ config }}"
}'
;