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
- 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 |
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 , certificateName | ||
list | select | subscriptionId , resourceGroupName , deploymentName | ||
create_or_update | insert | subscriptionId , resourceGroupName , deploymentName , certificateName | ||
delete | delete | subscriptionId , resourceGroupName , deploymentName , certificateName |
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 |
---|---|---|
certificateName | string | The name of certificate |
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
- list
Success
SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure_isv.nginx.certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND deploymentName = '{{ deploymentName }}' -- required
AND certificateName = '{{ certificateName }}' -- required
;
Success
SELECT
id,
name,
location,
properties,
systemData,
type
FROM azure_isv.nginx.certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND deploymentName = '{{ deploymentName }}' -- required
;
INSERT
examples
- create_or_update
- Manifest
No description available.
INSERT INTO azure_isv.nginx.certificates (
data__properties,
data__location,
subscriptionId,
resourceGroupName,
deploymentName,
certificateName
)
SELECT
'{{ properties }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ deploymentName }}',
'{{ certificateName }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;
# Description fields are for documentation purposes
- name: certificates
props:
- name: subscriptionId
value: string (uuid)
description: Required parameter for the certificates resource.
- name: resourceGroupName
value: string
description: Required parameter for the certificates resource.
- name: deploymentName
value: string
description: Required parameter for the certificates resource.
- name: certificateName
value: string
description: Required parameter for the certificates resource.
- name: properties
value: object
- name: location
value: string
DELETE
examples
- delete
No description available.
DELETE FROM azure_isv.nginx.certificates
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND deploymentName = '{{ deploymentName }}' --required
AND certificateName = '{{ certificateName }}' --required
;