Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Azure Targets

Description

Get information about all registered Azure targets. Use parameters as selection criteria to return a subset of the list.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/azure_target​[?account_name={string}[&default_read_preference=MINIMUM_LATENCY|
AFTER_ONLINE_POOL|AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|
LAST_RESORT|NEVER][&https=TRUE|FALSE][&last_page][&name={string}][&page_length={32‑bit integer}][&page_offset={32‑bit integer}][&page_start_marker={string}]​[&permit_going_out_of_sync=TRUE|FALSE]​[&quiesced=NO|PENDING|YES]​[&state=ONLINE|LIMITED_ACCESS|OFFLINE]

Request Parameters 

Parameter	Description	Required
account_name	Enter the account name for the Azure account in the in the Account Name field. Note: You can not use the same Account Name for multiple Azure targets.	no
default_read_ preference	When it is preferable to read from the Azure target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.	no
https	Whether the BlackPearl system uses the HTTPS protocol to setup and replicate data to the target. Values: TRUE, FALSE.	no
last_page	If included, only the last page of results is returned.	no
name	The name for the Azure target.	no
page_length	The maximum number of Azure targets to list. Default: all items after page_offset.	no
page_offset	The starting point for the first Azure targets to list. Default: 0.	no
page_start_marker	The UUID or other unique attribute for the item just before the first item to list. Notes:   § Specifying both page_offset and page_start_marker causes an error. § If neither page_offset, nor page_start_marker are specified, the page_offset default is used.	no
permit_going_out_of_sync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync. Note: This parameter is deprecated.	no
quiesced	Whether the Azure target is in a temporarily inactive state. Values: NO, PENDING, YES	no
state	The state of the Azure target. Values: ONLINE, OFFLINE, LIMITED_ACCESS	no

Responses

<Data>

   <AzureTarget>
     <AccountKey>{string}</AccountKey>

     <AccountName>{string}</AccountName>

     <AutoVerifyFrequencyInDays>
        {integer}

     </AutoVerifyFrequencyInDays>

     <CloudBucketPrefix>{string}</CloudBucketPrefix>
     <CloudBucketSuffix>{string}</CloudBucketSuffix>
     <DefaultReadPreference>
        MINIMUM_LATENCY|AFTER_ONLINE_POOL|AFTER_NEARLINE_POOL
        |AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER
     </DefaultReadPreference>

     <Https>TRUE|FALSE</Https>
     <Id>{string}</Id>

     <LastFullyVerified/>
     <Name>{string}</Name>
     <PermitGoingOutOfSync>TRUE|FALSE</PermitGoingOutOfSync>

     <Quiesced>NO|PENDING|YES</Quiesced>
     <State>ONLINE|OFFLINE|LIMITED_ACCESS</State>

   </AzureTarget>

...
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
AzureTarget	The container for a single Azure Target.
AccountKey	The account key associated with the account name below.
AccountName	The account name for the Microsoft Azure account in the in the Account Name field. Note: You can not use the same Account Name for multiple Microsoft Azure targets.
AutoVerify FrequencyInDays	The frequency at which a full verify of the data on the target is scheduled. If null, no full verify is scheduled. It is useful to schedule auto verify when the target is a storage domain in a data policy using replicate deletes. The verify ensures that deletes replicate in a timely manner.
CloudBucketPrefix	The Azure target bucket (blob storage container) prefix. Bucket names on the BlackPearl system must be unique within the BlackPearl system, but bucket names in Microsoft Azure must be unique across the world. To permit friendlier, shorter local bucket names on the BlackPearl system while avoiding naming conflicts with Azure, the BlackPearl system optionally adds the defined Cloud Bucket Prefix to the BlackPearl bucket name when it replicates the bucket.
CloudBucketSuffix	The Azure target bucket (blob storage container) suffix. Bucket names on the BlackPearl system must be unique within the BlackPearl system, but bucket names in Microsoft Azure must be unique across the world. To permit friendlier, shorter local bucket names on the BlackPearl system while avoiding naming conflicts with Azure, the BlackPearl system optionally adds the defined Cloud Bucket Suffix to the BlackPearl bucket name when it replicates the bucket.
DefaultRead Preference	When it is preferable to read from the Azure target rather than the replication source. Values: MINIMUM_LATENCY, AFTER_ONLINE_POOL, AFTER_NEARLINE_POOL, AFTER_NON_EJECTABLE_TAPE, LAST_RESORT, NEVER. See read_preference.
Https	Whether the BlackPearl system uses the HTTPS protocol to setup and replicate data to the target. Values: TRUE, FALSE.
Id	The UUID for the Azure target instance.
LastFullyVerified	The date and time the target was last fully verified in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Name	The name for the Azure target.
PermitGoingOutOfSync	Whether a target is allowed to be out of sync with the source. See permit_going_out_of_sync. Note: This parameter is deprecated.
Quiesced	Whether the Azure target is in a temporarily inactive state. Values: NO, PENDING, YES
State	The state of the Azure target. Values: ONLINE, OFFLINE, LIMITED_ACCESS

Example

Sample Request

This request gets information about all Azure targets registered to the source BlackPearl system.

GET http[s]://blackpearl-hostname/_rest_/azure_target HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<Data>

   <AzureTarget>

     <AccountKey>Pq1N85c4a</AccountKey>

     <AccountName>BackupAdmin</AccountName>

     <AutoVerifyFrequencyInDays/>

     <CloudBucketPrefix/>

     <CloudBucketSuffix/>

     <DefaultReadPreference>LAST_RESORT</DefaultReadPreference>

     <Https>TRUE</Https>

     <Id>8ea4b134-8a51-463d-9fd8-1948d19f6a7b</Id>

     <LastFullyVerified/>

     <Name>Azure-ef4b345d-64c7-4582-95ab-d25845f97531</Name>

     <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>

     <Quiesced>NO</Quiesced>

     <State>ONLINE</State>

   </AzureTarget>

   <AzureTarget>

     <AccountKey>Qllpsd52</AccountKey>

     <AccountName>BackupAdmin</AccountName>

     <AutoVerifyFrequencyInDays/>

     <CloudBucketPrefix/>

     <CloudBucketSuffix/>

     <DefaultReadPreference>LAST_RESORT</DefaultReadPreference>

     <Https>TRUE</Https>

     <Id>7b27f5bf-5ae7-4ce9-92e2-fd98092b2088</Id>

     <LastFullyVerified/>

     <Name>Azure-fda1b44d-0d30-47af-a0ff-25d7e6ac0dbd</Name>

     <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>

     <Quiesced>NO</Quiesced>

     <State>ONLINE</State>

   </AzureTarget>

</Data>