certificates

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

Overview

Name	certificates
Type	Resource
Id	azure_isv.nginx.certificates

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.
certificateError	object	Nginx Certificate Error Response Body.
certificateVirtualPath	string	:vartype certificate_virtual_path: str
keyVaultSecretCreated	string (date-time)	:vartype key_vault_secret_created: ~datetime.datetime
keyVaultSecretId	string	:vartype key_vault_secret_id: str
keyVaultSecretVersion	string	:vartype key_vault_secret_version: str
keyVirtualPath	string	:vartype key_virtual_path: str
location	string	The geo-location where the resource lives.
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)
sha1Thumbprint	string	:vartype sha1_thumbprint: 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.
certificateError	object	Nginx Certificate Error Response Body.
certificateVirtualPath	string	:vartype certificate_virtual_path: str
keyVaultSecretCreated	string (date-time)	:vartype key_vault_secret_created: ~datetime.datetime
keyVaultSecretId	string	:vartype key_vault_secret_id: str
keyVaultSecretVersion	string	:vartype key_vault_secret_version: str
keyVirtualPath	string	:vartype key_virtual_path: str
location	string	The geo-location where the resource lives.
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)
sha1Thumbprint	string	:vartype sha1_thumbprint: 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, certificate_name, subscription_id		Get a certificate of given NGINX deployment.
list	select	resource_group_name, deployment_name, subscription_id		List all certificates of given NGINX deployment.
create_or_update	insert	resource_group_name, deployment_name, certificate_name, subscription_id		Create or update the NGINX certificates for given NGINX deployment.
create_or_update	replace	resource_group_name, deployment_name, certificate_name, subscription_id		Create or update the NGINX certificates for given NGINX deployment.
delete	delete	resource_group_name, deployment_name, certificate_name, subscription_id		Deletes a certificate from the NGINX 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
certificate_name	string	The name of certificate. 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 a certificate of given NGINX deployment.

SELECT
id,
name,
certificateError,
certificateVirtualPath,
keyVaultSecretCreated,
keyVaultSecretId,
keyVaultSecretVersion,
keyVirtualPath,
location,
provisioningState,
sha1Thumbprint,
systemData,
type
FROM azure_isv.nginx.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND certificate_name = '{{ certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all certificates of given NGINX deployment.

SELECT
id,
name,
certificateError,
certificateVirtualPath,
keyVaultSecretCreated,
keyVaultSecretId,
keyVaultSecretVersion,
keyVirtualPath,
location,
provisioningState,
sha1Thumbprint,
systemData,
type
FROM azure_isv.nginx.certificates
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 certificates for given NGINX deployment.

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

Manifest

# Description fields are for documentation purposes
- name: certificates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the certificates resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the certificates resource.
  - name: certificate_name
    value: "{{ certificate_name }}"
    description: Required parameter for the certificates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the certificates resource.
  - name: properties
    description: |
      Nginx Certificate Properties.
    value:
      provisioningState: "{{ provisioningState }}"
      keyVirtualPath: "{{ keyVirtualPath }}"
      certificateVirtualPath: "{{ certificateVirtualPath }}"
      keyVaultSecretId: "{{ keyVaultSecretId }}"
      sha1Thumbprint: "{{ sha1Thumbprint }}"
      keyVaultSecretVersion: "{{ keyVaultSecretVersion }}"
      keyVaultSecretCreated: "{{ keyVaultSecretCreated }}"
      certificateError:
        code: "{{ code }}"
        message: "{{ message }}"
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.

REPLACE examples

create_or_update

Create or update the NGINX certificates for given NGINX deployment.

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

DELETE examples

delete

Deletes a certificate from the NGINX deployment.

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