custom_certificates

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

Overview

Name	custom_certificates
Type	Resource
Id	azure.web_pubsub.custom_certificates

Fields

The following fields are returned by SELECT queries:

get

Success. The response describe the corresponding custom certificate.

Name	Datatype	Description
properties	object	Custom certificate properties.

list

Success. The response describes custom certificates of the resource.

Name	Datatype	Description
properties	object	Custom certificate properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName, certificateName		Get a custom certificate.
list	select	subscriptionId, resourceGroupName, resourceName		List all custom certificates.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName, certificateName, data__properties		Create or update a custom certificate.
delete	delete	subscriptionId, resourceGroupName, resourceName, certificateName		Delete a custom 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
certificateName	string	Custom certificate name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a custom certificate.

SELECT
properties
FROM azure.web_pubsub.custom_certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND certificateName = '{{ certificateName }}' -- required
;

list

List all custom certificates.

SELECT
properties
FROM azure.web_pubsub.custom_certificates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

INSERT examples

create_or_update

Create or update a custom certificate.

INSERT INTO azure.web_pubsub.custom_certificates (
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
certificateName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ certificateName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: custom_certificates
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the custom_certificates resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_certificates resource.
    - name: resourceName
      value: string
      description: Required parameter for the custom_certificates resource.
    - name: certificateName
      value: string
      description: Required parameter for the custom_certificates resource.
    - name: properties
      value: object
      description: |
        Custom certificate properties.

DELETE examples

delete

Delete a custom certificate.

DELETE FROM azure.web_pubsub.custom_certificates
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND certificateName = '{{ certificateName }}' --required
;