mesh_volume

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

Overview

Name	mesh_volume
Type	Resource
Id	azure.service_fabric_dataplane.mesh_volume

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string
azureFileParameters	object	This type describes a volume provided by an Azure Files file share. All required parameters must be populated in order to send to Azure.
description	string
provider	string	Required. Provider of the volume. Default value: "SFAzureFile" .
status	string	Status of the volume. Possible values include: 'Unknown', 'Ready', 'Upgrading', 'Creating', 'Deleting', 'Failed'
statusDetails	string	Gives additional information about the current status of the volume.

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	volume_resource_name, endpoint		Gets the Volume resource with the given name. Gets the information about the Volume resource with the given name. The information include the description and other properties of the Volume.
list	select	endpoint		Lists all the volume resources. Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
create_or_update	insert	volume_resource_name, endpoint, name, properties		Creates or updates a Volume resource. Creates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the specified description and properties.
create_or_update	replace	volume_resource_name, endpoint, name, properties		Creates or updates a Volume resource. Creates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the specified description and properties.
delete	delete	volume_resource_name, endpoint		Deletes the Volume resource. Deletes the Volume 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
endpoint	string	The service endpoint host (no scheme). (default: )
volume_resource_name	string	The identity of the volume.

SELECT examples

get

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

SELECT
name,
azureFileParameters,
description,
provider,
status,
statusDetails
FROM azure.service_fabric_dataplane.mesh_volume
WHERE volume_resource_name = '{{ volume_resource_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

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

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: mesh_volume
props:
  - name: volume_resource_name
    value: "{{ volume_resource_name }}"
    description: Required parameter for the mesh_volume resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the mesh_volume resource.
  - name: name
    value: "{{ name }}"
  - name: properties
    value:
      description: "{{ description }}"
      provider: "{{ provider }}"
      azureFileParameters:
        accountName: "{{ accountName }}"
        accountKey: "{{ accountKey }}"
        shareName: "{{ shareName }}"

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Deletes the Volume resource. Deletes the Volume resource identified by the name.

DELETE FROM azure.service_fabric_dataplane.mesh_volume
WHERE volume_resource_name = '{{ volume_resource_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;