certificates

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

Overview

Name	certificates
Type	Resource
Id	azure_extras.sphere.certificates

Fields

The following fields are returned by SELECT queries:

retrieve_proof_of_possession_nonce

Name	Datatype	Description
certificate	string	The certificate as a UTF-8 encoded base 64 string.
expiryUtc	string (date-time)	The certificate expiry date.
notBeforeUtc	string (date-time)	The certificate not before date.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
status	string	The certificate status. Known values are: "Active", "Inactive", "Expired", and "Revoked".
subject	string	The certificate subject.
thumbprint	string	The certificate thumbprint.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
certificate	string	The certificate as a UTF-8 encoded base 64 string.
expiryUtc	string (date-time)	The certificate expiry date.
notBeforeUtc	string (date-time)	The certificate not before date.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
status	string	The certificate status. Known values are: "Active", "Inactive", "Expired", and "Revoked".
subject	string	The certificate subject.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	The certificate thumbprint.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_catalog

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
certificate	string	The certificate as a UTF-8 encoded base 64 string.
expiryUtc	string (date-time)	The certificate expiry date.
notBeforeUtc	string (date-time)	The certificate not before date.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
status	string	The certificate status. Known values are: "Active", "Inactive", "Expired", and "Revoked".
subject	string	The certificate subject.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
thumbprint	string	The certificate thumbprint.
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
retrieve_proof_of_possession_nonce	select	resource_group_name, catalog_name, serial_number, subscription_id		Gets the proof of possession nonce.
get	select	resource_group_name, catalog_name, serial_number, subscription_id		Get a Certificate.
list_by_catalog	select	resource_group_name, catalog_name, subscription_id	$filter, $top, $skip, $maxpagesize	List Certificate resources by Catalog.
retrieve_cert_chain	exec	resource_group_name, catalog_name, serial_number, subscription_id		Retrieves cert chain.

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
catalog_name	string	Name of catalog. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
serial_number	string	Serial number of the certificate. Use '.default' to get current active certificate. Required.
subscription_id	string
$filter	string	Filter the result list using the given expression. Default value is None.
$maxpagesize	integer	The maximum number of result items per page. Default value is None.
$skip	integer	The number of result items to skip. Default value is None.
$top	integer	The number of result items to return. Default value is None.

SELECT examples

retrieve_proof_of_possession_nonce

Gets the proof of possession nonce.

SELECT
certificate,
expiryUtc,
notBeforeUtc,
provisioningState,
status,
subject,
thumbprint
FROM azure_extras.sphere.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND serial_number = '{{ serial_number }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a Certificate.

SELECT
id,
name,
certificate,
expiryUtc,
notBeforeUtc,
provisioningState,
status,
subject,
systemData,
thumbprint,
type
FROM azure_extras.sphere.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND serial_number = '{{ serial_number }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_catalog

List Certificate resources by Catalog.

SELECT
id,
name,
certificate,
expiryUtc,
notBeforeUtc,
provisioningState,
status,
subject,
systemData,
thumbprint,
type
FROM azure_extras.sphere.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND catalog_name = '{{ catalog_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $maxpagesize = '{{ $maxpagesize }}'
;

Lifecycle Methods

retrieve_cert_chain

Retrieves cert chain.

EXEC azure_extras.sphere.certificates.retrieve_cert_chain 
@resource_group_name='{{ resource_group_name }}' --required, 
@catalog_name='{{ catalog_name }}' --required, 
@serial_number='{{ serial_number }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;