certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.sphere.certificates

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

list_by_catalog

Azure operation completed successfully.

Name	Datatype	Description
properties	object	The resource-specific properties for this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, catalogName, serialNumber		Get a Certificate
list_by_catalog	select	subscriptionId, resourceGroupName, catalogName	$filter, $top, $skip, $maxpagesize	List Certificate resources by Catalog
retrieve_cert_chain	exec	subscriptionId, resourceGroupName, catalogName, serialNumber		Retrieves cert chain.
retrieve_proof_of_possession_nonce	exec	subscriptionId, resourceGroupName, catalogName, serialNumber, proofOfPossessionNonce		Gets the proof of possession nonce.

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
catalogName	string	Name of catalog
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serialNumber	string	Serial number of the certificate. Use '.default' to get current active certificate.
subscriptionId	string	The ID of the target subscription.
$filter	string	Filter the result list using the given expression
$maxpagesize	integer (int32)	The maximum number of result items per page.
$skip	integer (int32)	The number of result items to skip.
$top	integer (int32)	The number of result items to return.

SELECT examples

get

Get a Certificate

SELECT
properties
FROM azure.sphere.certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND serialNumber = '{{ serialNumber }}' -- required
;

list_by_catalog

List Certificate resources by Catalog

SELECT
properties
FROM azure.sphere.certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND catalogName = '{{ catalogName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $maxpagesize = '{{ $maxpagesize }}'
;

Lifecycle Methods

retrieve_cert_chain

Retrieves cert chain.

EXEC azure.sphere.certificates.retrieve_cert_chain 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required, 
@serialNumber='{{ serialNumber }}' --required
;

retrieve_proof_of_possession_nonce

Gets the proof of possession nonce.

EXEC azure.sphere.certificates.retrieve_proof_of_possession_nonce 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@catalogName='{{ catalogName }}' --required, 
@serialNumber='{{ serialNumber }}' --required 
@@json=
'{
"proofOfPossessionNonce": "{{ proofOfPossessionNonce }}"
}'
;