mesh_secret

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

Overview

Name	mesh_secret
Type	Resource
Id	azure.service_fabric_dataplane.mesh_secret

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
contentType	string
description	string
kind	string
status	string	Status of the resource. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
statusDetails	string	Gives additional information about the current status of the secret.

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, endpoint		Gets the Secret resource with the given name. Gets the information about the Secret resource with the given name. The information include the description and other properties of the Secret.
list	select	endpoint		Lists all the secret resources. Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.
create_or_update	insert	secret_resource_name, endpoint, properties, name		Creates or updates a Secret resource. Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.
create_or_update	replace	secret_resource_name, endpoint, properties, name		Creates or updates a Secret resource. Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.
delete	delete	secret_resource_name, endpoint		Deletes the Secret resource. Deletes the specified Secret resource and all of its named values.

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.

SELECT examples

get

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

SELECT
name,
contentType,
description,
kind,
status,
statusDetails
FROM azure.service_fabric_dataplane.mesh_secret
WHERE secret_resource_name = '{{ secret_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

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

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

INSERT examples

create_or_update

Creates or updates a Secret resource. Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.

INSERT INTO azure.service_fabric_dataplane.mesh_secret (
properties,
name,
secret_resource_name,
endpoint
)
SELECT 
'{{ properties }}' /* required */,
'{{ name }}' /* required */,
'{{ secret_resource_name }}',
'{{ endpoint }}'
RETURNING
name,
properties
;

Manifest

# Description fields are for documentation purposes
- name: mesh_secret
props:
  - name: secret_resource_name
    value: "{{ secret_resource_name }}"
    description: Required parameter for the mesh_secret resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the mesh_secret resource.
  - name: properties
    description: |
      Describes the properties of a secret resource. You probably want to use the sub-classes and not this class directly. Known sub-classes are: InlinedValueSecretResourceProperties Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
    value:
      kind: "{{ kind }}"
      description: "{{ description }}"
      status: "{{ status }}"
      statusDetails: "{{ statusDetails }}"
      contentType: "{{ contentType }}"
  - name: name
    value: "{{ name }}"

REPLACE examples

create_or_update

Creates or updates a Secret resource. Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.

REPLACE azure.service_fabric_dataplane.mesh_secret
SET 
properties = '{{ properties }}',
name = '{{ name }}'
WHERE 
secret_resource_name = '{{ secret_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND properties = '{{ properties }}' --required
AND name = '{{ name }}' --required
RETURNING
name,
properties;

DELETE examples

delete

Deletes the Secret resource. Deletes the specified Secret resource and all of its named values.

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