volumes_replications
Creates, updates, deletes, gets or lists a volumes_replications
resource.
Overview
Name | volumes_replications |
Type | Resource |
Id | azure_isv.netapp.volumes_replications |
Fields
The following fields are returned by SELECT
queries:
- list
Name | Datatype | Description |
---|---|---|
endpointType | string | Indicates whether the local volume is the source or destination for the Volume Replication |
remoteVolumeRegion | string | The remote region for the other end of the Volume Replication. |
remoteVolumeResourceId | string | The resource ID of the remote volume. |
replicationId | string | UUID v4 used to identify the replication. (pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$ , example: 5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8) |
replicationSchedule | string | Schedule |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list | select | subscriptionId , resourceGroupName , accountName , poolName , volumeName | List all replications for a specified volume | |
delete | exec | subscriptionId , resourceGroupName , accountName , poolName , volumeName | Delete the replication connection on the destination volume, and send release to the source replication |
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 |
---|---|---|
accountName | string | The name of the NetApp account |
poolName | string | The name of the capacity pool |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string (uuid) | The ID of the target subscription. The value must be an UUID. |
volumeName | string | The name of the volume |
SELECT
examples
- list
List all replications for a specified volume
SELECT
endpointType,
remoteVolumeRegion,
remoteVolumeResourceId,
replicationId,
replicationSchedule
FROM azure_isv.netapp.volumes_replications
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
;
Lifecycle Methods
- delete
Delete the replication connection on the destination volume, and send release to the source replication
EXEC azure_isv.netapp.volumes_replications.delete
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@accountName='{{ accountName }}' --required,
@poolName='{{ poolName }}' --required,
@volumeName='{{ volumeName }}' --required
;