Devices - List Failover Sets

Returns all failover sets for a given device and their eligibility for participating in a failover. A failover set refers to a set of volume containers that need to be failed-over as a single unit to maintain data integrity.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/listFailoverSets?api-version=2017-06-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription id

resourceGroupName
path True
  • string

The resource group name

managerName
path True
  • string

The manager name

deviceName
path True
  • string

The device name

api-version
query True
  • string

The api version

Responses

Name Type Description
200 OK

Returns the list of failover sets on the given device.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

DevicesListFailoverSets

Sample Request

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/listFailoverSets?api-version=2017-06-01

Sample Response

{
  "value": [
    {
      "volumeContainers": [
        {
          "volumeContainerId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/volumeContainers/vcforsdktest",
          "volumes": [
            {
              "volumeId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/volumeContainers/vcforsdktest/volumes/jemVol1",
              "volumeType": "Tiered",
              "sizeInBytes": 5368709120,
              "backupCreatedDate": "2017-06-20T06:30:03.794Z",
              "backupElementId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backups/964d5a65-5294-4707-9c71-becb8850ea12/elements/2553386f-f39e-4223-b9fa-319adc5630fe_0000000000000000",
              "backupId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backups/964d5a65-5294-4707-9c71-becb8850ea12",
              "backupPolicyId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backupPolicies/jembkpolicy"
            }
          ]
        }
      ],
      "eligibilityResult": {
        "isEligibleForFailover": true
      }
    },
    {
      "volumeContainers": [
        {
          "volumeContainerId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/volumeContainers/vcForOdataFilterTest",
          "volumes": [
            {
              "volumeId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/volumeContainers/vcForOdataFilterTest/volumes/vol01",
              "volumeType": "Tiered",
              "sizeInBytes": 10737418240,
              "backupCreatedDate": "2017-06-10T10:29:37.215Z",
              "backupElementId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backups/0874889e-f2a3-42d2-a643-f378fc199688/elements/5baae396-46f1-46a0-bc25-d8e2fcada7fa_0000000000000000",
              "backupId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backups/0874889e-f2a3-42d2-a643-f378fc199688",
              "backupPolicyId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backupPolicies/BkUpPolicyForSDKTest429326237"
            },
            {
              "volumeId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/volumeContainers/vcForOdataFilterTest/volumes/vol%2540123",
              "volumeType": "Tiered",
              "sizeInBytes": 10737418240,
              "backupCreatedDate": "2017-06-10T10:29:37.215Z",
              "backupElementId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backups/0874889e-f2a3-42d2-a643-f378fc199688/elements/5c7eb677-d688-4afb-a352-ca62454d5921_0000000000000000",
              "backupId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backups/0874889e-f2a3-42d2-a643-f378fc199688",
              "backupPolicyId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/backupPolicies/BkUpPolicyForSDKTest429326237"
            }
          ]
        }
      ],
      "eligibilityResult": {
        "isEligibleForFailover": true
      }
    }
  ]
}

Definitions

FailoverSet

The failover set on a device.

FailoverSetEligibilityResult

The eligibility result of failover set, for failover.

FailoverSetsList

The list of failover sets.

VolumeContainerFailoverMetadata

The metadata of the volume container, that is being considered as part of a failover set.

VolumeFailoverMetadata

The metadata of a volume that has valid cloud snapshot.

VolumeType

The volume type.

FailoverSet

The failover set on a device.

Name Type Description
eligibilityResult

The eligibility result of the failover set, for failover.

volumeContainers

The list of meta data of volume containers, which are part of the failover set.

FailoverSetEligibilityResult

The eligibility result of failover set, for failover.

Name Type Description
errorMessage
  • string

The error message, if the failover set is not eligible for failover.

isEligibleForFailover
  • boolean

Represents if this failover set is eligible for failover or not.

FailoverSetsList

The list of failover sets.

Name Type Description
value

The list of failover sets.

VolumeContainerFailoverMetadata

The metadata of the volume container, that is being considered as part of a failover set.

Name Type Description
volumeContainerId
  • string

The path ID of the volume container.

volumes

The list of metadata of volumes inside the volume container, which contains valid cloud snapshots.

VolumeFailoverMetadata

The metadata of a volume that has valid cloud snapshot.

Name Type Description
backupCreatedDate
  • string

The date at which the snapshot was taken.

backupElementId
  • string

The path ID of the backup-element for this volume, inside the backup set.

backupId
  • string

The path ID of the backup set.

backupPolicyId
  • string

The path ID of the backup policy using which the snapshot was taken.

sizeInBytes
  • integer

The size of the volume in bytes at the time the snapshot was taken.

volumeId
  • string

The path ID of the volume.

volumeType

The type of the volume.

VolumeType

The volume type.

Name Type Description
Archival
  • string
LocallyPinned
  • string
Tiered
  • string