mesh_secret_value

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

Overview

Name	mesh_secret_value
Type	Resource
Id	azure.service_fabric_dataplane.mesh_secret_value

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
value	string

list

Name	Datatype	Description
ContinuationToken	string
Items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	secret_resource_name, secret_value_resource_name, endpoint		Gets the specified secret value resource. Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
list	select	secret_resource_name, endpoint		List names of all values of the specified secret resource. Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.
delete	delete	secret_resource_name, secret_value_resource_name, endpoint		Deletes the specified value of the named secret resource. Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.
add_value	exec	secret_resource_name, secret_value_resource_name, endpoint, name		Adds the specified value as a new version of the specified secret resource. Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.
show	exec	secret_resource_name, secret_value_resource_name, endpoint		Lists the specified value of the secret resource. Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.

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
endpoint	string	The service endpoint host (no scheme). (default: )
secret_resource_name	string	The name of the secret resource.
secret_value_resource_name	string	The name of the secret resource value which is typically the version identifier for the value.

SELECT examples

get

Gets the specified secret value resource. Get the information about the specified named secret value resources. The information does not include the actual value of the secret.

SELECT
name,
value
FROM azure.service_fabric_dataplane.mesh_secret_value
WHERE secret_resource_name = '{{ secret_resource_name }}' -- required
AND secret_value_resource_name = '{{ secret_value_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List names of all values of the specified secret resource. Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.

SELECT
ContinuationToken,
Items
FROM azure.service_fabric_dataplane.mesh_secret_value
WHERE secret_resource_name = '{{ secret_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

DELETE examples

delete

Deletes the specified value of the named secret resource. Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.

DELETE FROM azure.service_fabric_dataplane.mesh_secret_value
WHERE secret_resource_name = '{{ secret_resource_name }}' --required
AND secret_value_resource_name = '{{ secret_value_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

add_value

Adds the specified value as a new version of the specified secret resource. Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.

EXEC azure.service_fabric_dataplane.mesh_secret_value.add_value 
@secret_resource_name='{{ secret_resource_name }}' --required, 
@secret_value_resource_name='{{ secret_value_resource_name }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"name": "{{ name }}", 
"properties": "{{ properties }}"
}'
;

show

Lists the specified value of the secret resource. Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.

EXEC azure.service_fabric_dataplane.mesh_secret_value.show 
@secret_resource_name='{{ secret_resource_name }}' --required, 
@secret_value_resource_name='{{ secret_value_resource_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;