secrets

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

Overview

Name	secrets
Type	Resource
Id	azure.cdn.secrets

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.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
parameters	object	object which contains secret parameters.
profileName	string	The name of the profile which holds the secret.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
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_profile

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.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
parameters	object	object which contains secret parameters.
profileName	string	The name of the profile which holds the secret.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
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, profile_name, secret_name, subscription_id		Gets an existing Secret within a profile.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Lists existing AzureFrontDoor secrets.
create	insert	resource_group_name, profile_name, secret_name, subscription_id		Creates a new Secret within the specified profile.
delete	delete	resource_group_name, profile_name, secret_name, subscription_id		Deletes an existing Secret within 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
profile_name	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
secret_name	string	Name of the Secret under the profile. Required.
subscription_id	string

SELECT examples

get

Gets an existing Secret within a profile.

SELECT
id,
name,
deploymentStatus,
parameters,
profileName,
provisioningState,
systemData,
type
FROM azure.cdn.secrets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND secret_name = '{{ secret_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Lists existing AzureFrontDoor secrets.

SELECT
id,
name,
deploymentStatus,
parameters,
profileName,
provisioningState,
systemData,
type
FROM azure.cdn.secrets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new Secret within the specified profile.

INSERT INTO azure.cdn.secrets (
properties,
resource_group_name,
profile_name,
secret_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ secret_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: secrets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the secrets resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the secrets resource.
  - name: secret_name
    value: "{{ secret_name }}"
    description: Required parameter for the secrets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the secrets resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the Secret to create.
    value:
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"
      profileName: "{{ profileName }}"
      parameters:
        type: "{{ type }}"

DELETE examples

delete

Deletes an existing Secret within profile.

DELETE FROM azure.cdn.secrets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND secret_name = '{{ secret_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;