deployments

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

Overview

Name	deployments
Type	Resource
Id	azure_isv.nginx.deployments

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.
autoUpgradeProfile	object	Autoupgrade settings of a deployment.
dataplaneApiEndpoint	string	Dataplane API endpoint for the caller to update the NGINX state of the deployment.
enableDiagnosticsSupport	boolean	:vartype enable_diagnostics_support: bool
identity	object	Identity Properties.
ipAddress	string	The IP address of the deployment.
location	string	The geo-location where the resource lives. Required.
logging	object	Nginx Logging.
networkProfile	object	Nginx Network Profile.
nginxAppProtect	object	Settings for NGINX App Protect (NAP).
nginxVersion	string	:vartype nginx_version: str
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)
scalingProperties	object	Information on how the deployment will be scaled.
sku	object	Resource Sku.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userProfile	object	Nginx Deployment User Profile.

list_by_resource_group

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.
autoUpgradeProfile	object	Autoupgrade settings of a deployment.
dataplaneApiEndpoint	string	Dataplane API endpoint for the caller to update the NGINX state of the deployment.
enableDiagnosticsSupport	boolean	:vartype enable_diagnostics_support: bool
identity	object	Identity Properties.
ipAddress	string	The IP address of the deployment.
location	string	The geo-location where the resource lives. Required.
logging	object	Nginx Logging.
networkProfile	object	Nginx Network Profile.
nginxAppProtect	object	Settings for NGINX App Protect (NAP).
nginxVersion	string	:vartype nginx_version: str
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)
scalingProperties	object	Information on how the deployment will be scaled.
sku	object	Resource Sku.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userProfile	object	Nginx Deployment User Profile.

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.
autoUpgradeProfile	object	Autoupgrade settings of a deployment.
dataplaneApiEndpoint	string	Dataplane API endpoint for the caller to update the NGINX state of the deployment.
enableDiagnosticsSupport	boolean	:vartype enable_diagnostics_support: bool
identity	object	Identity Properties.
ipAddress	string	The IP address of the deployment.
location	string	The geo-location where the resource lives. Required.
logging	object	Nginx Logging.
networkProfile	object	Nginx Network Profile.
nginxAppProtect	object	Settings for NGINX App Protect (NAP).
nginxVersion	string	:vartype nginx_version: str
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)
scalingProperties	object	Information on how the deployment will be scaled.
sku	object	Resource Sku.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userProfile	object	Nginx Deployment User Profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, deployment_name, subscription_id		Get the NGINX deployment.
list_by_resource_group	select	resource_group_name, subscription_id		List all NGINX deployments under the specified resource group.
list	select	subscription_id		List the NGINX deployments resources.
create_or_update	insert	resource_group_name, deployment_name, subscription_id, location		Create or update the NGINX deployment.
update	update	resource_group_name, deployment_name, subscription_id		Update the NGINX deployment.
create_or_update	replace	resource_group_name, deployment_name, subscription_id, location		Create or update the NGINX deployment.
delete	delete	resource_group_name, deployment_name, subscription_id		Delete the NGINX deployment resource.

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
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 deployment.

SELECT
id,
name,
autoUpgradeProfile,
dataplaneApiEndpoint,
enableDiagnosticsSupport,
identity,
ipAddress,
location,
logging,
networkProfile,
nginxAppProtect,
nginxVersion,
provisioningState,
scalingProperties,
sku,
systemData,
tags,
type,
userProfile
FROM azure_isv.nginx.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all NGINX deployments under the specified resource group.

SELECT
id,
name,
autoUpgradeProfile,
dataplaneApiEndpoint,
enableDiagnosticsSupport,
identity,
ipAddress,
location,
logging,
networkProfile,
nginxAppProtect,
nginxVersion,
provisioningState,
scalingProperties,
sku,
systemData,
tags,
type,
userProfile
FROM azure_isv.nginx.deployments
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List the NGINX deployments resources.

SELECT
id,
name,
autoUpgradeProfile,
dataplaneApiEndpoint,
enableDiagnosticsSupport,
identity,
ipAddress,
location,
logging,
networkProfile,
nginxAppProtect,
nginxVersion,
provisioningState,
scalingProperties,
sku,
systemData,
tags,
type,
userProfile
FROM azure_isv.nginx.deployments
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the NGINX deployment.

INSERT INTO azure_isv.nginx.deployments (
tags,
location,
properties,
identity,
sku,
resource_group_name,
deployment_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ deployment_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the deployments resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the deployments resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the deployments resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Nginx Deployment Properties.
    value:
      provisioningState: "{{ provisioningState }}"
      nginxVersion: "{{ nginxVersion }}"
      networkProfile:
        frontEndIPConfiguration:
          publicIPAddresses:
            - id: "{{ id }}"
          privateIPAddresses:
            - privateIPAddress: "{{ privateIPAddress }}"
              privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
              subnetId: "{{ subnetId }}"
        networkInterfaceConfiguration:
          subnetId: "{{ subnetId }}"
      ipAddress: "{{ ipAddress }}"
      enableDiagnosticsSupport: {{ enableDiagnosticsSupport }}
      logging:
        storageAccount:
          accountName: "{{ accountName }}"
          containerName: "{{ containerName }}"
      scalingProperties:
        capacity: {{ capacity }}
        autoScaleSettings:
          profiles:
            - name: "{{ name }}"
              capacity:
                min: {{ min }}
                max: {{ max }}
      autoUpgradeProfile:
        upgradeChannel: "{{ upgradeChannel }}"
      userProfile:
        preferredEmail: "{{ preferredEmail }}"
      nginxAppProtect:
        webApplicationFirewallSettings:
          activationState: "{{ activationState }}"
        webApplicationFirewallStatus:
          wafRelease: "{{ wafRelease }}"
          attackSignaturesPackage:
            version: "{{ version }}"
            revisionDatetime: "{{ revisionDatetime }}"
          botSignaturesPackage:
            version: "{{ version }}"
            revisionDatetime: "{{ revisionDatetime }}"
          threatCampaignsPackage:
            version: "{{ version }}"
            revisionDatetime: "{{ revisionDatetime }}"
          componentVersions:
            wafEngineVersion: "{{ wafEngineVersion }}"
            wafNginxVersion: "{{ wafNginxVersion }}"
      dataplaneApiEndpoint: "{{ dataplaneApiEndpoint }}"
  - name: identity
    description: |
      Identity Properties.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      Resource Sku.
    value:
      name: "{{ name }}"

UPDATE examples

update

Update the NGINX deployment.

UPDATE azure_isv.nginx.deployments
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
sku = '{{ sku }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update the NGINX deployment.

REPLACE azure_isv.nginx.deployments
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete the NGINX deployment resource.

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