certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.app_containers.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.
certificateKeyVaultProperties	object	Properties for a certificate stored in a Key Vault.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
expirationDate	string (date-time)	Certificate expiration date.
issueDate	string (date-time)	Certificate issue Date.
issuer	string	Certificate issuer.
location	string	The geo-location where the resource lives. Required.
password	string	Certificate password.
provisioningState	string	Provisioning state of the certificate. Known values are: "Succeeded", "Failed", "Canceled", "DeleteFailed", "Pending", and "Deleting". (Succeeded, Failed, Canceled, DeleteFailed, Pending, Deleting)
publicKeyHash	string	Public key hash.
subjectAlternativeNames	array	Subject alternative names the certificate applies to.
subjectName	string	Subject name of the certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
thumbprint	string	Certificate thumbprint.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
valid	boolean	Is the certificate valid?.
value	string (byte)	PFX or PEM blob.

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.
certificateKeyVaultProperties	object	Properties for a certificate stored in a Key Vault.
deploymentErrors	string	Any errors that occurred during deployment or deployment validation.
expirationDate	string (date-time)	Certificate expiration date.
issueDate	string (date-time)	Certificate issue Date.
issuer	string	Certificate issuer.
location	string	The geo-location where the resource lives. Required.
password	string	Certificate password.
provisioningState	string	Provisioning state of the certificate. Known values are: "Succeeded", "Failed", "Canceled", "DeleteFailed", "Pending", and "Deleting". (Succeeded, Failed, Canceled, DeleteFailed, Pending, Deleting)
publicKeyHash	string	Public key hash.
subjectAlternativeNames	array	Subject alternative names the certificate applies to.
subjectName	string	Subject name of the certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
thumbprint	string	Certificate thumbprint.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
valid	boolean	Is the certificate valid?.
value	string (byte)	PFX or PEM blob.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, environment_name, certificate_name, subscription_id		Get the specified Certificate. Get the specified Certificate.
list	select	resource_group_name, environment_name, subscription_id		Get the Certificates in a given managed environment. Get the Certificates in a given managed environment.
create_or_update	insert	resource_group_name, environment_name, certificate_name, subscription_id, location		Create or Update a Certificate. Create or Update a Certificate.
update	update	resource_group_name, environment_name, certificate_name, subscription_id		Update properties of a certificate. Patches a certificate. Currently only patching of tags is supported.
create_or_update	replace	resource_group_name, environment_name, certificate_name, subscription_id, location		Create or Update a Certificate. Create or Update a Certificate.
delete	delete	resource_group_name, environment_name, certificate_name, subscription_id		Deletes the specified Certificate. Deletes the specified Certificate.

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	Name of the Certificate. Required.
environment_name	string	Name of the Managed Environment. 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 specified Certificate. Get the specified Certificate.

SELECT
id,
name,
certificateKeyVaultProperties,
deploymentErrors,
expirationDate,
issueDate,
issuer,
location,
password,
provisioningState,
publicKeyHash,
subjectAlternativeNames,
subjectName,
systemData,
tags,
thumbprint,
type,
valid,
value
FROM azure.app_containers.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND certificate_name = '{{ certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get the Certificates in a given managed environment. Get the Certificates in a given managed environment.

SELECT
id,
name,
certificateKeyVaultProperties,
deploymentErrors,
expirationDate,
issueDate,
issuer,
location,
password,
provisioningState,
publicKeyHash,
subjectAlternativeNames,
subjectName,
systemData,
tags,
thumbprint,
type,
valid,
value
FROM azure.app_containers.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update a Certificate. Create or Update a Certificate.

INSERT INTO azure.app_containers.certificates (
tags,
location,
properties,
resource_group_name,
environment_name,
certificate_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ certificate_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
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: environment_name
    value: "{{ environment_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: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Certificate resource specific properties.
    value:
      provisioningState: "{{ provisioningState }}"
      deploymentErrors: "{{ deploymentErrors }}"
      certificateKeyVaultProperties:
        identity: "{{ identity }}"
        keyVaultUrl: "{{ keyVaultUrl }}"
      password: "{{ password }}"
      subjectName: "{{ subjectName }}"
      subjectAlternativeNames:
        - "{{ subjectAlternativeNames }}"
      value: "{{ value }}"
      issuer: "{{ issuer }}"
      issueDate: "{{ issueDate }}"
      expirationDate: "{{ expirationDate }}"
      thumbprint: "{{ thumbprint }}"
      valid: {{ valid }}
      publicKeyHash: "{{ publicKeyHash }}"

UPDATE examples

update

Update properties of a certificate. Patches a certificate. Currently only patching of tags is supported.

UPDATE azure.app_containers.certificates
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or Update a Certificate. Create or Update a Certificate.

REPLACE azure.app_containers.certificates
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified Certificate. Deletes the specified Certificate.

DELETE FROM azure.app_containers.certificates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;