certificates

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

Overview

Name	certificates
Type	Resource
Id	azure.app_service.certificates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Certificate resource specific properties
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_resource_group

OK.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Certificate resource specific properties
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

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Certificate resource specific properties
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	resourceGroupName, name, subscriptionId		Description for Get a certificate.
list_by_resource_group	select	resourceGroupName, subscriptionId		Description for Get all certificates in a resource group.
list	select	subscriptionId	$filter	Description for Get all certificates for a subscription.
create_or_update	insert	resourceGroupName, name, subscriptionId		Description for Create or update a certificate.
update	update	resourceGroupName, name, subscriptionId		Description for Create or update a certificate.
delete	delete	resourceGroupName, name, subscriptionId		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.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
$filter	string	Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'

SELECT examples

get

Description for Get a certificate.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Description for Get all certificates in a resource group.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Description for Get all certificates for a subscription.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.app_service.certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Description for Create or update a certificate.

INSERT INTO azure.app_service.certificates (
data__properties,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: certificates
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the certificates resource.
    - name: name
      value: string
      description: Required parameter for the certificates resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the certificates resource.
    - name: properties
      value: object
      description: |
        Certificate resource specific properties

UPDATE examples

update

Description for Create or update a certificate.

UPDATE azure.app_service.certificates
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Description for Delete a certificate.

DELETE FROM azure.app_service.certificates
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;