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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
files	array	:vartype files: list[~azure.mgmt.nginx.models.NginxConfigurationFile]
package	object	Nginx Configuration Package.
protectedFiles	array	:vartype protected_files: list[~azure.mgmt.nginx.models.NginxConfigurationProtectedFileResponse]
provisioningState	string	Provisioning State. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
rootFile	string	:vartype root_file: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
files	array	:vartype files: list[~azure.mgmt.nginx.models.NginxConfigurationFile]
package	object	Nginx Configuration Package.
protectedFiles	array	:vartype protected_files: list[~azure.mgmt.nginx.models.NginxConfigurationProtectedFileResponse]
provisioningState	string	Provisioning State. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
rootFile	string	:vartype root_file: str
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, deployment_name, configuration_name, subscription_id		Get the NGINX configuration of given NGINX deployment.
list	select	resource_group_name, deployment_name, subscription_id		List the NGINX configuration of given NGINX deployment.
create_or_update	insert	resource_group_name, deployment_name, configuration_name, subscription_id		Create or update the NGINX configuration for given NGINX deployment.
create_or_update	replace	resource_group_name, deployment_name, configuration_name, subscription_id		Create or update the NGINX configuration for given NGINX deployment.
delete	delete	resource_group_name, deployment_name, configuration_name, subscription_id		Reset the NGINX configuration of given NGINX deployment to default.
analysis	exec	resource_group_name, deployment_name, configuration_name, subscription_id, config		Analyze an NGINX configuration without applying it to the NGINXaaS deployment.

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_name	string	The name of configuration, only 'default' is supported value due to the singleton of NGINX conf. Required.
deployment_name	string	The name of targeted NGINX deployment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the NGINX configuration of given NGINX deployment.

SELECT
id,
name,
files,
package,
protectedFiles,
provisioningState,
rootFile,
systemData,
type
FROM azure_isv.nginx.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND configuration_name = '{{ configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List the NGINX configuration of given NGINX deployment.

SELECT
id,
name,
files,
package,
protectedFiles,
provisioningState,
rootFile,
systemData,
type
FROM azure_isv.nginx.configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the NGINX configuration for given NGINX deployment.

INSERT INTO azure_isv.nginx.configurations (
properties,
resource_group_name,
deployment_name,
configuration_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ deployment_name }}',
'{{ configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the configurations resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the configurations resource.
  - name: configuration_name
    value: "{{ configuration_name }}"
    description: Required parameter for the configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the configurations resource.
  - name: properties
    description: |
      Nginx Configuration Request Properties.
    value:
      provisioningState: "{{ provisioningState }}"
      files:
        - content: "{{ content }}"
          virtualPath: "{{ virtualPath }}"
      protectedFiles:
        - content: "{{ content }}"
          virtualPath: "{{ virtualPath }}"
          contentHash: "{{ contentHash }}"
      package:
        data: "{{ data }}"
        protectedFiles:
          - "{{ protectedFiles }}"
      rootFile: "{{ rootFile }}"

REPLACE examples

create_or_update

Create or update the NGINX configuration for given NGINX deployment.

REPLACE azure_isv.nginx.configurations
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Reset the NGINX configuration of given NGINX deployment to default.

DELETE FROM azure_isv.nginx.configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND configuration_name = '{{ configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

analysis

Analyze an NGINX configuration without applying it to the NGINXaaS deployment.

EXEC azure_isv.nginx.configurations.analysis 
@resource_group_name='{{ resource_group_name }}' --required, 
@deployment_name='{{ deployment_name }}' --required, 
@configuration_name='{{ configuration_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"config": "{{ config }}"
}'
;