managed_certificates

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

Overview

Name	managed_certificates
Type	Resource
Id	azure.app_containers.managed_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.
domainControlValidation	string	Selected type of domain control validation for managed certificates. Known values are: "CNAME", "HTTP", and "TXT". (CNAME, HTTP, TXT)
error	string	Any error occurred during the certificate provision.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the certificate. Known values are: "Succeeded", "Failed", "Canceled", "DeleteFailed", "Pending", and "Deleting". (Succeeded, Failed, Canceled, DeleteFailed, Pending, Deleting)
subjectName	string	Subject name of the certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationToken	string	A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.

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.
domainControlValidation	string	Selected type of domain control validation for managed certificates. Known values are: "CNAME", "HTTP", and "TXT". (CNAME, HTTP, TXT)
error	string	Any error occurred during the certificate provision.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the certificate. Known values are: "Succeeded", "Failed", "Canceled", "DeleteFailed", "Pending", and "Deleting". (Succeeded, Failed, Canceled, DeleteFailed, Pending, Deleting)
subjectName	string	Subject name of the certificate.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationToken	string	A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, environment_name, managed_certificate_name, subscription_id		Get the specified Managed Certificate. Get the specified Managed Certificate.
list	select	resource_group_name, environment_name, subscription_id		Get the Managed Certificates in a given managed environment. Get the Managed Certificates in a given managed environment.
create_or_update	insert	resource_group_name, environment_name, managed_certificate_name, subscription_id, location		Create or Update a Managed Certificate. Create or Update a Managed Certificate.
update	update	resource_group_name, environment_name, managed_certificate_name, subscription_id		Update tags of a managed certificate. Patches a managed certificate. Oly patching of tags is supported.
create_or_update	replace	resource_group_name, environment_name, managed_certificate_name, subscription_id, location		Create or Update a Managed Certificate. Create or Update a Managed Certificate.
delete	delete	resource_group_name, environment_name, managed_certificate_name, subscription_id		Deletes the specified Managed Certificate. Deletes the specified Managed 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
environment_name	string	Name of the Environment. Required.
managed_certificate_name	string	Name of the Managed Certificate. 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 Managed Certificate. Get the specified Managed Certificate.

SELECT
id,
name,
domainControlValidation,
error,
location,
provisioningState,
subjectName,
systemData,
tags,
type,
validationToken
FROM azure.app_containers.managed_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND environment_name = '{{ environment_name }}' -- required
AND managed_certificate_name = '{{ managed_certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
domainControlValidation,
error,
location,
provisioningState,
subjectName,
systemData,
tags,
type,
validationToken
FROM azure.app_containers.managed_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 Managed Certificate. Create or Update a Managed Certificate.

INSERT INTO azure.app_containers.managed_certificates (
tags,
location,
properties,
resource_group_name,
environment_name,
managed_certificate_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ environment_name }}',
'{{ managed_certificate_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_certificates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_certificates resource.
  - name: environment_name
    value: "{{ environment_name }}"
    description: Required parameter for the managed_certificates resource.
  - name: managed_certificate_name
    value: "{{ managed_certificate_name }}"
    description: Required parameter for the managed_certificates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_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 }}"
      subjectName: "{{ subjectName }}"
      error: "{{ error }}"
      domainControlValidation: "{{ domainControlValidation }}"
      validationToken: "{{ validationToken }}"

UPDATE examples

update

Update tags of a managed certificate. Patches a managed certificate. Oly patching of tags is supported.

UPDATE azure.app_containers.managed_certificates
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND managed_certificate_name = '{{ managed_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 Managed Certificate. Create or Update a Managed Certificate.

REPLACE azure.app_containers.managed_certificates
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND environment_name = '{{ environment_name }}' --required
AND managed_certificate_name = '{{ managed_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 Managed Certificate. Deletes the specified Managed Certificate.

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