certificate_profiles

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

Overview

Name	certificate_profiles
Type	Resource
Id	azure.artifact_signing.certificate_profiles

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.
certificates	array	List of renewed certificates.
identityValidationId	string	Identity validation id used for the certificate subject name. Required.
includeCity	boolean	Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types.
includeCountry	boolean	Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types.
includePostalCode	boolean	Whether to include PC in the certificate subject name.
includeState	boolean	Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types.
includeStreetAddress	boolean	Whether to include STREET in the certificate subject name.
profileType	string	Profile type of the certificate. Required. Known values are: "PublicTrust", "PrivateTrust", "PrivateTrustCIPolicy", "VBSEnclave", and "PublicTrustTest". (PublicTrust, PrivateTrust, PrivateTrustCIPolicy, VBSEnclave, PublicTrustTest)
programType	string	Indicates whether the resource is intended for a specific usage scenario.
provisioningState	string	Status of the current operation on certificate profile. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Updating, Deleting, Accepted)
status	string	Status of the certificate profile. Known values are: "Active", "Disabled", and "Suspended". (Active, Disabled, Suspended)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_code_signing_account

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.
certificates	array	List of renewed certificates.
identityValidationId	string	Identity validation id used for the certificate subject name. Required.
includeCity	boolean	Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types.
includeCountry	boolean	Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types.
includePostalCode	boolean	Whether to include PC in the certificate subject name.
includeState	boolean	Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types.
includeStreetAddress	boolean	Whether to include STREET in the certificate subject name.
profileType	string	Profile type of the certificate. Required. Known values are: "PublicTrust", "PrivateTrust", "PrivateTrustCIPolicy", "VBSEnclave", and "PublicTrustTest". (PublicTrust, PrivateTrust, PrivateTrustCIPolicy, VBSEnclave, PublicTrustTest)
programType	string	Indicates whether the resource is intended for a specific usage scenario.
provisioningState	string	Status of the current operation on certificate profile. Known values are: "Succeeded", "Failed", "Canceled", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Updating, Deleting, Accepted)
status	string	Status of the certificate profile. Known values are: "Active", "Disabled", and "Suspended". (Active, Disabled, Suspended)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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
get	select	resource_group_name, account_name, profile_name, subscription_id		Get details of a certificate profile.
list_by_code_signing_account	select	resource_group_name, account_name, subscription_id		List certificate profiles under an artifact signing account.
create	insert	resource_group_name, account_name, profile_name, subscription_id		Create a certificate profile.
delete	delete	resource_group_name, account_name, profile_name, subscription_id		Delete a certificate profile.
revoke_certificates	exec	resource_group_name, account_name, profile_name, subscription_id, revokeCertificates		Revokes certificates under a certificate profile.

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
account_name	string	Artifact Signing account name. Required.
profile_name	string	Certificate profile name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get details of a certificate profile.

SELECT
id,
name,
certificates,
identityValidationId,
includeCity,
includeCountry,
includePostalCode,
includeState,
includeStreetAddress,
profileType,
programType,
provisioningState,
status,
systemData,
type
FROM azure.artifact_signing.certificate_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_code_signing_account

List certificate profiles under an artifact signing account.

SELECT
id,
name,
certificates,
identityValidationId,
includeCity,
includeCountry,
includePostalCode,
includeState,
includeStreetAddress,
profileType,
programType,
provisioningState,
status,
systemData,
type
FROM azure.artifact_signing.certificate_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a certificate profile.

INSERT INTO azure.artifact_signing.certificate_profiles (
properties,
resource_group_name,
account_name,
profile_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ profile_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: certificate_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the certificate_profiles resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the certificate_profiles resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the certificate_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the certificate_profiles resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      profileType: "{{ profileType }}"
      includeStreetAddress: {{ includeStreetAddress }}
      includeCity: {{ includeCity }}
      includeState: {{ includeState }}
      includeCountry: {{ includeCountry }}
      includePostalCode: {{ includePostalCode }}
      identityValidationId: "{{ identityValidationId }}"
      programType: "{{ programType }}"
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      certificates:
        - serialNumber: "{{ serialNumber }}"
          enhancedKeyUsage: "{{ enhancedKeyUsage }}"
          subjectName: "{{ subjectName }}"
          thumbprint: "{{ thumbprint }}"
          createdDate: "{{ createdDate }}"
          expiryDate: "{{ expiryDate }}"
          status: "{{ status }}"
          revocation:
            requestedAt: "{{ requestedAt }}"
            effectiveAt: "{{ effectiveAt }}"
            reason: "{{ reason }}"
            remarks: "{{ remarks }}"
            status: "{{ status }}"
            failureReason: "{{ failureReason }}"

DELETE examples

delete

Delete a certificate profile.

DELETE FROM azure.artifact_signing.certificate_profiles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

revoke_certificates

Revokes certificates under a certificate profile.

EXEC azure.artifact_signing.certificate_profiles.revoke_certificates 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"revokeCertificates": "{{ revokeCertificates }}"
}'
;