Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storsimple
  5. listDeviceFailoverTars
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.storsimple.listDeviceFailoverTars

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Given a list of volume containers to be failed over from a source device, this method returns the eligibility result, as a failover target, for all devices under that resource.

Uses Azure REST API version 2017-06-01.

Using listDeviceFailoverTars

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function listDeviceFailoverTars(args: ListDeviceFailoverTarsArgs, opts?: InvokeOptions): Promise<ListDeviceFailoverTarsResult>
function listDeviceFailoverTarsOutput(args: ListDeviceFailoverTarsOutputArgs, opts?: InvokeOptions): Output<ListDeviceFailoverTarsResult>
Copy
def list_device_failover_tars(manager_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              source_device_name: Optional[str] = None,
                              volume_containers: Optional[Sequence[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> ListDeviceFailoverTarsResult
def list_device_failover_tars_output(manager_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              source_device_name: Optional[pulumi.Input[str]] = None,
                              volume_containers: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[ListDeviceFailoverTarsResult]
Copy
func ListDeviceFailoverTars(ctx *Context, args *ListDeviceFailoverTarsArgs, opts ...InvokeOption) (*ListDeviceFailoverTarsResult, error)
func ListDeviceFailoverTarsOutput(ctx *Context, args *ListDeviceFailoverTarsOutputArgs, opts ...InvokeOption) ListDeviceFailoverTarsResultOutput
Copy

> Note: This function is named ListDeviceFailoverTars in the Go SDK.

public static class ListDeviceFailoverTars 
{
    public static Task<ListDeviceFailoverTarsResult> InvokeAsync(ListDeviceFailoverTarsArgs args, InvokeOptions? opts = null)
    public static Output<ListDeviceFailoverTarsResult> Invoke(ListDeviceFailoverTarsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListDeviceFailoverTarsResult> listDeviceFailoverTars(ListDeviceFailoverTarsArgs args, InvokeOptions options)
public static Output<ListDeviceFailoverTarsResult> listDeviceFailoverTars(ListDeviceFailoverTarsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storsimple:listDeviceFailoverTars
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
SourceDeviceName
This property is required.
Changes to this property will trigger replacement.
string
The source device name on which failover is performed.
VolumeContainers List<string>
The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.
ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
SourceDeviceName
This property is required.
Changes to this property will trigger replacement.
string
The source device name on which failover is performed.
VolumeContainers []string
The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
sourceDeviceName
This property is required.
Changes to this property will trigger replacement.
String
The source device name on which failover is performed.
volumeContainers List<String>
The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.
managerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
sourceDeviceName
This property is required.
Changes to this property will trigger replacement.
string
The source device name on which failover is performed.
volumeContainers string[]
The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.
manager_name
This property is required.
Changes to this property will trigger replacement.
str
The manager name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name
source_device_name
This property is required.
Changes to this property will trigger replacement.
str
The source device name on which failover is performed.
volume_containers Sequence[str]
The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
sourceDeviceName
This property is required.
Changes to this property will trigger replacement.
String
The source device name on which failover is performed.
volumeContainers List<String>
The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.

listDeviceFailoverTars Result

The following output properties are available:

Value []FailoverTargetResponse
The list of all the failover targets.
value List<FailoverTargetResponse>
The list of all the failover targets.
value FailoverTargetResponse[]
The list of all the failover targets.
value Sequence[FailoverTargetResponse]
The list of all the failover targets.
value List<Property Map>
The list of all the failover targets.

Supporting Types

FailoverTargetResponse

AvailableLocalStorageInBytes double
The amount of free local storage available on the device in bytes.
AvailableTieredStorageInBytes double
The amount of free tiered storage available for the device in bytes.
DataContainersCount int
The count of data containers on the device.
DeviceId string
The path ID of the device.
DeviceLocation string
The geo location (applicable only for cloud appliances) of the device.
DeviceSoftwareVersion string
The software version of the device.
DeviceStatus string
The status of the device.
EligibilityResult Pulumi.AzureNative.StorSimple.Inputs.TargetEligibilityResultResponse
The eligibility result of the device, as a failover target device.
FriendlyDeviceSoftwareVersion string
The friendly name for the current version of software on the device.
ModelDescription string
The model number of the device.
VolumesCount int
The count of volumes on the device.
AvailableLocalStorageInBytes float64
The amount of free local storage available on the device in bytes.
AvailableTieredStorageInBytes float64
The amount of free tiered storage available for the device in bytes.
DataContainersCount int
The count of data containers on the device.
DeviceId string
The path ID of the device.
DeviceLocation string
The geo location (applicable only for cloud appliances) of the device.
DeviceSoftwareVersion string
The software version of the device.
DeviceStatus string
The status of the device.
EligibilityResult TargetEligibilityResultResponse
The eligibility result of the device, as a failover target device.
FriendlyDeviceSoftwareVersion string
The friendly name for the current version of software on the device.
ModelDescription string
The model number of the device.
VolumesCount int
The count of volumes on the device.
availableLocalStorageInBytes Double
The amount of free local storage available on the device in bytes.
availableTieredStorageInBytes Double
The amount of free tiered storage available for the device in bytes.
dataContainersCount Integer
The count of data containers on the device.
deviceId String
The path ID of the device.
deviceLocation String
The geo location (applicable only for cloud appliances) of the device.
deviceSoftwareVersion String
The software version of the device.
deviceStatus String
The status of the device.
eligibilityResult TargetEligibilityResultResponse
The eligibility result of the device, as a failover target device.
friendlyDeviceSoftwareVersion String
The friendly name for the current version of software on the device.
modelDescription String
The model number of the device.
volumesCount Integer
The count of volumes on the device.
availableLocalStorageInBytes number
The amount of free local storage available on the device in bytes.
availableTieredStorageInBytes number
The amount of free tiered storage available for the device in bytes.
dataContainersCount number
The count of data containers on the device.
deviceId string
The path ID of the device.
deviceLocation string
The geo location (applicable only for cloud appliances) of the device.
deviceSoftwareVersion string
The software version of the device.
deviceStatus string
The status of the device.
eligibilityResult TargetEligibilityResultResponse
The eligibility result of the device, as a failover target device.
friendlyDeviceSoftwareVersion string
The friendly name for the current version of software on the device.
modelDescription string
The model number of the device.
volumesCount number
The count of volumes on the device.
available_local_storage_in_bytes float
The amount of free local storage available on the device in bytes.
available_tiered_storage_in_bytes float
The amount of free tiered storage available for the device in bytes.
data_containers_count int
The count of data containers on the device.
device_id str
The path ID of the device.
device_location str
The geo location (applicable only for cloud appliances) of the device.
device_software_version str
The software version of the device.
device_status str
The status of the device.
eligibility_result TargetEligibilityResultResponse
The eligibility result of the device, as a failover target device.
friendly_device_software_version str
The friendly name for the current version of software on the device.
model_description str
The model number of the device.
volumes_count int
The count of volumes on the device.
availableLocalStorageInBytes Number
The amount of free local storage available on the device in bytes.
availableTieredStorageInBytes Number
The amount of free tiered storage available for the device in bytes.
dataContainersCount Number
The count of data containers on the device.
deviceId String
The path ID of the device.
deviceLocation String
The geo location (applicable only for cloud appliances) of the device.
deviceSoftwareVersion String
The software version of the device.
deviceStatus String
The status of the device.
eligibilityResult Property Map
The eligibility result of the device, as a failover target device.
friendlyDeviceSoftwareVersion String
The friendly name for the current version of software on the device.
modelDescription String
The model number of the device.
volumesCount Number
The count of volumes on the device.

TargetEligibilityErrorMessageResponse

Message string
The localized error message stating the reason why the device is not eligible as a target device.
Resolution string
The localized resolution message for the error.
ResultCode string
The result code for the error, due to which the device does not qualify as a failover target device.
Message string
The localized error message stating the reason why the device is not eligible as a target device.
Resolution string
The localized resolution message for the error.
ResultCode string
The result code for the error, due to which the device does not qualify as a failover target device.
message String
The localized error message stating the reason why the device is not eligible as a target device.
resolution String
The localized resolution message for the error.
resultCode String
The result code for the error, due to which the device does not qualify as a failover target device.
message string
The localized error message stating the reason why the device is not eligible as a target device.
resolution string
The localized resolution message for the error.
resultCode string
The result code for the error, due to which the device does not qualify as a failover target device.
message str
The localized error message stating the reason why the device is not eligible as a target device.
resolution str
The localized resolution message for the error.
result_code str
The result code for the error, due to which the device does not qualify as a failover target device.
message String
The localized error message stating the reason why the device is not eligible as a target device.
resolution String
The localized resolution message for the error.
resultCode String
The result code for the error, due to which the device does not qualify as a failover target device.

TargetEligibilityResultResponse

EligibilityStatus string
The eligibility status of device, as a failover target device.
Messages List<Pulumi.AzureNative.StorSimple.Inputs.TargetEligibilityErrorMessageResponse>
The list of error messages, if a device does not qualify as a failover target device.
EligibilityStatus string
The eligibility status of device, as a failover target device.
Messages []TargetEligibilityErrorMessageResponse
The list of error messages, if a device does not qualify as a failover target device.
eligibilityStatus String
The eligibility status of device, as a failover target device.
messages List<TargetEligibilityErrorMessageResponse>
The list of error messages, if a device does not qualify as a failover target device.
eligibilityStatus string
The eligibility status of device, as a failover target device.
messages TargetEligibilityErrorMessageResponse[]
The list of error messages, if a device does not qualify as a failover target device.
eligibility_status str
The eligibility status of device, as a failover target device.
messages Sequence[TargetEligibilityErrorMessageResponse]
The list of error messages, if a device does not qualify as a failover target device.
eligibilityStatus String
The eligibility status of device, as a failover target device.
messages List<Property Map>
The list of error messages, if a device does not qualify as a failover target device.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native