secrets

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

Overview

Name	secrets
Type	Resource
Id	azure.service_fabric_mesh.secrets

Fields

The following fields are returned by SELECT queries:

get

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

list_by_resource_group

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

list_by_subscription

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Describes the properties of a secret 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	api-version	Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
list_by_subscription	select	subscriptionId	api-version	Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.
create	insert	subscriptionId, resourceGroupName, secretResourceName, data__properties	api-version	Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.
delete	delete	subscriptionId, resourceGroupName, secretResourceName	api-version	Deletes the secret resource identified by the name.

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.
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

Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.

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

list_by_resource_group

Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.

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

list_by_subscription

Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.

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

INSERT examples

create

Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.

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

Manifest

# Description fields are for documentation purposes
- name: secrets
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the secrets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the secrets resource.
    - name: secretResourceName
      value: string
      description: Required parameter for the secrets 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: |
        Describes the properties of a secret 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 resource identified by the name.

DELETE FROM azure.service_fabric_mesh.secrets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND secretResourceName = '{{ secretResourceName }}' --required
AND api-version = '{{ api-version }}'
;