volumes

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

Overview

Name	volumes
Type	Resource
Id	azure.service_fabric_mesh.volumes

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 volume resource.
tags	object	Resource tags.

list_by_resource_group

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

list_by_subscription

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	This type describes properties of a volume 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, volumeResourceName	api-version	Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.
list_by_subscription	select	subscriptionId	api-version	Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.
create	insert	subscriptionId, resourceGroupName, volumeResourceName, data__properties	api-version	Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.
delete	delete	subscriptionId, resourceGroupName, volumeResourceName	api-version	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
resourceGroupName	string	Azure resource group name
subscriptionId	string	The customer subscription identifier
volumeResourceName	string	The identity of the volume.
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 volume resource with the given name. The information include the description and other properties of the volume.

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

list_by_resource_group

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

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

list_by_subscription

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

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

INSERT examples

create

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

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

Manifest

# Description fields are for documentation purposes
- name: volumes
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the volumes resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the volumes resource.
    - name: volumeResourceName
      value: string
      description: Required parameter for the volumes 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 volume 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 volume resource identified by the name.

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