product_secrets

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

Overview

Name	product_secrets
Type	Resource
Id	azure_stack.deployment_admin.product_secrets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	Properties of a product secret.
type	string	Type of Resource.

list

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	Properties of a product secret.
type	string	Type of Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, packageId, secretName		Returns the specific product secret.
list	select	subscriptionId, packageId		Returns an array of product secrets.
set	exec	subscriptionId, packageId, secretName		Imports a product secret.
validate	exec	subscriptionId, packageId, secretName		Validates a product secret.

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
packageId	string	The package identifier.
secretName	string	The secret name.
subscriptionId	string	Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Returns the specific product secret.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.deployment_admin.product_secrets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND packageId = '{{ packageId }}' -- required
AND secretName = '{{ secretName }}' -- required
;

list

Returns an array of product secrets.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.deployment_admin.product_secrets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND packageId = '{{ packageId }}' -- required
;

Lifecycle Methods

set

Imports a product secret.

EXEC azure_stack.deployment_admin.product_secrets.set 
@subscriptionId='{{ subscriptionId }}' --required, 
@packageId='{{ packageId }}' --required, 
@secretName='{{ secretName }}' --required 
@@json=
'{
"value": "{{ value }}", 
"data": "{{ data }}", 
"password": "{{ password }}", 
"key": "{{ key }}"
}'
;

validate

Validates a product secret.

EXEC azure_stack.deployment_admin.product_secrets.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@packageId='{{ packageId }}' --required, 
@secretName='{{ secretName }}' --required 
@@json=
'{
"value": "{{ value }}", 
"data": "{{ data }}", 
"password": "{{ password }}", 
"key": "{{ key }}"
}'
;