web_pub_sub_custom_certificates

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

Overview

Name	web_pub_sub_custom_certificates
Type	Resource
Id	azure.web_pubsub.web_pub_sub_custom_certificates

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
keyVaultBaseUri	string	Base uri of the KeyVault that stores certificate. Required.
keyVaultSecretName	string	Certificate secret name. Required.
keyVaultSecretVersion	string	Certificate secret version.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
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	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
keyVaultBaseUri	string	Base uri of the KeyVault that stores certificate. Required.
keyVaultSecretName	string	Certificate secret name. Required.
keyVaultSecretVersion	string	Certificate secret version.
provisioningState	string	Provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", "Running", "Creating", "Updating", "Deleting", and "Moving".
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, resource_name, certificate_name, subscription_id		Get a custom certificate.
list	select	resource_group_name, resource_name, subscription_id		List all custom certificates.
create_or_update	insert	resource_group_name, resource_name, certificate_name, subscription_id, properties		Create or update a custom certificate.
create_or_update	replace	resource_group_name, resource_name, certificate_name, subscription_id, properties		Create or update a custom certificate.
delete	delete	resource_group_name, resource_name, certificate_name, subscription_id		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
certificate_name	string	Custom certificate name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the resource. Required.
subscription_id	string

SELECT examples

get

Get a custom certificate.

SELECT
id,
name,
keyVaultBaseUri,
keyVaultSecretName,
keyVaultSecretVersion,
provisioningState,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_custom_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND certificate_name = '{{ certificate_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all custom certificates.

SELECT
id,
name,
keyVaultBaseUri,
keyVaultSecretName,
keyVaultSecretVersion,
provisioningState,
systemData,
type
FROM azure.web_pubsub.web_pub_sub_custom_certificates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a custom certificate.

INSERT INTO azure.web_pubsub.web_pub_sub_custom_certificates (
properties,
resource_group_name,
resource_name,
certificate_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ certificate_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_pub_sub_custom_certificates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the web_pub_sub_custom_certificates resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the web_pub_sub_custom_certificates resource.
  - name: certificate_name
    value: "{{ certificate_name }}"
    description: Required parameter for the web_pub_sub_custom_certificates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the web_pub_sub_custom_certificates resource.
  - name: properties
    value:
      keyVaultBaseUri: "{{ keyVaultBaseUri }}"
      keyVaultSecretName: "{{ keyVaultSecretName }}"
      keyVaultSecretVersion: "{{ keyVaultSecretVersion }}"

REPLACE examples

create_or_update

Create or update a custom certificate.

REPLACE azure.web_pubsub.web_pub_sub_custom_certificates
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a custom certificate.

DELETE FROM azure.web_pubsub.web_pub_sub_custom_certificates
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND certificate_name = '{{ certificate_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;