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
name	string
identity	object
location	string
properties	object
sku	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string

list_by_resource_group

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

list

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, deploymentName
list_by_resource_group	select	subscriptionId, resourceGroupName
list	select	subscriptionId
create_or_update	insert	subscriptionId, resourceGroupName, deploymentName
update	update	subscriptionId, resourceGroupName, deploymentName
delete	delete	subscriptionId, resourceGroupName, deploymentName

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
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,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure_isv.nginx.deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND deploymentName = '{{ deploymentName }}' -- required
;

list_by_resource_group

Success

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure_isv.nginx.deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Success

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure_isv.nginx.deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

No description available.

INSERT INTO azure_isv.nginx.deployments (
data__identity,
data__properties,
data__tags,
data__sku,
data__location,
subscriptionId,
resourceGroupName,
deploymentName
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ sku }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ deploymentName }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

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

UPDATE examples

update

No description available.

UPDATE azure_isv.nginx.deployments
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__sku = '{{ sku }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

No description available.

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