secret_values

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

Overview

Name	secret_values
Type	Resource
Id	azure.service_fabric_mesh.secret_values

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	This type describes properties of a secret value resource.
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	This type describes properties of a secret value resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, secretResourceName, secretValueResourceName	api-version	Get the information about the specified named secret value resources. The information does not include the actual value of the secret.
list	select	subscriptionId, resourceGroupName, secretResourceName	api-version	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.
create	insert	subscriptionId, resourceGroupName, secretResourceName, secretValueResourceName, data__properties	api-version	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.
delete	delete	subscriptionId, resourceGroupName, secretResourceName, secretValueResourceName	api-version	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.

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
resourceGroupName	string	Azure resource group name
secretResourceName	string	The name of the secret resource.
secretValueResourceName	string	The name of the secret resource value which is typically the version identifier for the value.
subscriptionId	string	The customer subscription identifier
api-version	string	The version of the API. This parameter is required and its value must be 2018-09-01-preview.

SELECT examples

get

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

SELECT
location,
properties,
tags
FROM azure.service_fabric_mesh.secret_values
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND secretResourceName = '{{ secretResourceName }}' -- required
AND secretValueResourceName = '{{ secretValueResourceName }}' -- required
AND api-version = '{{ api-version }}'
;

list

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
location,
properties,
tags
FROM azure.service_fabric_mesh.secret_values
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND secretResourceName = '{{ secretResourceName }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

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.

INSERT INTO azure.service_fabric_mesh.secret_values (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
secretResourceName,
secretValueResourceName,
api-version
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ secretResourceName }}',
'{{ secretValueResourceName }}',
'{{ api-version }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: secret_values
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the secret_values resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the secret_values resource.
    - name: secretResourceName
      value: string
      description: Required parameter for the secret_values resource.
    - name: secretValueResourceName
      value: string
      description: Required parameter for the secret_values resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        This type describes properties of a secret value resource.
    - name: api-version
      value: string
      description: The version of the API. This parameter is required and its value must be `2018-09-01-preview`.

DELETE examples

delete

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_mesh.secret_values
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND secretResourceName = '{{ secretResourceName }}' --required
AND secretValueResourceName = '{{ secretValueResourceName }}' --required
AND api-version = '{{ api-version }}'
;