certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.web.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.
canonicalName	string	CNAME of the certificate to be issued via free certificate.
cerBlob	string (byte)	Raw bytes of .cer file.
domainValidationMethod	string	Method of domain validation for free cert.
expirationDate	string (date-time)	Certificate expiration date.
friendlyName	string	Friendly name of the certificate.
hostNames	array	Host names the certificate applies to.
hostingEnvironmentProfile	object	Specification for the App Service Environment to use for the certificate.
issueDate	string (date-time)	Certificate issue Date.
issuer	string	Certificate issuer.
keyVaultId	string	Azure Key Vault Csm resource Id.
keyVaultSecretName	string	Azure Key Vault secret name.
keyVaultSecretStatus	string	Status of the Key Vault secret. Known values are: "Initialized", "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed", "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault", "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey", and "Unknown". (Initialized, WaitingOnCertificateOrder, Succeeded, CertificateOrderFailed, OperationNotPermittedOnKeyVault, AzureServiceUnauthorizedToAccessKeyVault, KeyVaultDoesNotExist, KeyVaultSecretDoesNotExist, UnknownError, ExternalPrivateKey, Unknown)
kind	string	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference _ for details supported values for kind.
location	string	The geo-location where the resource lives. Required.
password	string	Certificate password.
pfxBlob	string (byte)	Pfx blob.
publicKeyHash	string	Public key hash.
selfLink	string	Self link.
serverFarmId	string	Resource ID of the associated App Service plan.
siteName	string	App name.
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?.

list_by_resource_group

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.
canonicalName	string	CNAME of the certificate to be issued via free certificate.
cerBlob	string (byte)	Raw bytes of .cer file.
domainValidationMethod	string	Method of domain validation for free cert.
expirationDate	string (date-time)	Certificate expiration date.
friendlyName	string	Friendly name of the certificate.
hostNames	array	Host names the certificate applies to.
hostingEnvironmentProfile	object	Specification for the App Service Environment to use for the certificate.
issueDate	string (date-time)	Certificate issue Date.
issuer	string	Certificate issuer.
keyVaultId	string	Azure Key Vault Csm resource Id.
keyVaultSecretName	string	Azure Key Vault secret name.
keyVaultSecretStatus	string	Status of the Key Vault secret. Known values are: "Initialized", "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed", "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault", "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey", and "Unknown". (Initialized, WaitingOnCertificateOrder, Succeeded, CertificateOrderFailed, OperationNotPermittedOnKeyVault, AzureServiceUnauthorizedToAccessKeyVault, KeyVaultDoesNotExist, KeyVaultSecretDoesNotExist, UnknownError, ExternalPrivateKey, Unknown)
kind	string	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference _ for details supported values for kind.
location	string	The geo-location where the resource lives. Required.
password	string	Certificate password.
pfxBlob	string (byte)	Pfx blob.
publicKeyHash	string	Public key hash.
selfLink	string	Self link.
serverFarmId	string	Resource ID of the associated App Service plan.
siteName	string	App name.
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?.

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.
canonicalName	string	CNAME of the certificate to be issued via free certificate.
cerBlob	string (byte)	Raw bytes of .cer file.
domainValidationMethod	string	Method of domain validation for free cert.
expirationDate	string (date-time)	Certificate expiration date.
friendlyName	string	Friendly name of the certificate.
hostNames	array	Host names the certificate applies to.
hostingEnvironmentProfile	object	Specification for the App Service Environment to use for the certificate.
issueDate	string (date-time)	Certificate issue Date.
issuer	string	Certificate issuer.
keyVaultId	string	Azure Key Vault Csm resource Id.
keyVaultSecretName	string	Azure Key Vault secret name.
keyVaultSecretStatus	string	Status of the Key Vault secret. Known values are: "Initialized", "WaitingOnCertificateOrder", "Succeeded", "CertificateOrderFailed", "OperationNotPermittedOnKeyVault", "AzureServiceUnauthorizedToAccessKeyVault", "KeyVaultDoesNotExist", "KeyVaultSecretDoesNotExist", "UnknownError", "ExternalPrivateKey", and "Unknown". (Initialized, WaitingOnCertificateOrder, Succeeded, CertificateOrderFailed, OperationNotPermittedOnKeyVault, AzureServiceUnauthorizedToAccessKeyVault, KeyVaultDoesNotExist, KeyVaultSecretDoesNotExist, UnknownError, ExternalPrivateKey, Unknown)
kind	string	Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference _ for details supported values for kind.
location	string	The geo-location where the resource lives. Required.
password	string	Certificate password.
pfxBlob	string (byte)	Pfx blob.
publicKeyHash	string	Public key hash.
selfLink	string	Self link.
serverFarmId	string	Resource ID of the associated App Service plan.
siteName	string	App name.
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?.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, name, subscription_id		Get a certificate. Description for Get a certificate.
list_by_resource_group	select	resource_group_name, subscription_id		Get all certificates in a resource group. Description for Get all certificates in a resource group.
list	select	subscription_id	$filter	Get all certificates for a subscription. Description for Get all certificates for a subscription.
create_or_update	insert	resource_group_name, name, subscription_id, location		Create or update a certificate. Description for Create or update a certificate.
update	update	resource_group_name, name, subscription_id		Create or update a certificate. Description for Create or update a certificate.
create_or_update	replace	resource_group_name, name, subscription_id, location		Create or update a certificate. Description for Create or update a certificate.
delete	delete	resource_group_name, name, subscription_id		Delete a certificate. Description for Delete a 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
name	string	Name of the certificate. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'. Default value is None.

SELECT examples

get

Get a certificate. Description for Get a certificate.

SELECT
id,
name,
canonicalName,
cerBlob,
domainValidationMethod,
expirationDate,
friendlyName,
hostNames,
hostingEnvironmentProfile,
issueDate,
issuer,
keyVaultId,
keyVaultSecretName,
keyVaultSecretStatus,
kind,
location,
password,
pfxBlob,
publicKeyHash,
selfLink,
serverFarmId,
siteName,
subjectName,
systemData,
tags,
thumbprint,
type,
valid
FROM azure.web.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all certificates in a resource group. Description for Get all certificates in a resource group.

SELECT
id,
name,
canonicalName,
cerBlob,
domainValidationMethod,
expirationDate,
friendlyName,
hostNames,
hostingEnvironmentProfile,
issueDate,
issuer,
keyVaultId,
keyVaultSecretName,
keyVaultSecretStatus,
kind,
location,
password,
pfxBlob,
publicKeyHash,
selfLink,
serverFarmId,
siteName,
subjectName,
systemData,
tags,
thumbprint,
type,
valid
FROM azure.web.certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all certificates for a subscription. Description for Get all certificates for a subscription.

SELECT
id,
name,
canonicalName,
cerBlob,
domainValidationMethod,
expirationDate,
friendlyName,
hostNames,
hostingEnvironmentProfile,
issueDate,
issuer,
keyVaultId,
keyVaultSecretName,
keyVaultSecretStatus,
kind,
location,
password,
pfxBlob,
publicKeyHash,
selfLink,
serverFarmId,
siteName,
subjectName,
systemData,
tags,
thumbprint,
type,
valid
FROM azure.web.certificates
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update a certificate. Description for Create or update a certificate.

INSERT INTO azure.web.certificates (
tags,
location,
properties,
kind,
resource_group_name,
name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
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: name
    value: "{{ 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:
      password: "{{ password }}"
      friendlyName: "{{ friendlyName }}"
      subjectName: "{{ subjectName }}"
      hostNames:
        - "{{ hostNames }}"
      pfxBlob: "{{ pfxBlob }}"
      siteName: "{{ siteName }}"
      selfLink: "{{ selfLink }}"
      issuer: "{{ issuer }}"
      issueDate: "{{ issueDate }}"
      expirationDate: "{{ expirationDate }}"
      thumbprint: "{{ thumbprint }}"
      valid: {{ valid }}
      cerBlob: "{{ cerBlob }}"
      publicKeyHash: "{{ publicKeyHash }}"
      hostingEnvironmentProfile:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
      keyVaultId: "{{ keyVaultId }}"
      keyVaultSecretName: "{{ keyVaultSecretName }}"
      keyVaultSecretStatus: "{{ keyVaultSecretStatus }}"
      serverFarmId: "{{ serverFarmId }}"
      canonicalName: "{{ canonicalName }}"
      domainValidationMethod: "{{ domainValidationMethod }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of resource. If the resource is an app, you can refer to `https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference `_ for details supported values for kind.

UPDATE examples

update

Create or update a certificate. Description for Create or update a certificate.

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

REPLACE examples

create_or_update

Create or update a certificate. Description for Create or update a certificate.

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

DELETE examples

delete

Delete a certificate. Description for Delete a certificate.

DELETE FROM azure.web.certificates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;