Spectra Logic

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

Register Azure Target

Description

Connect to and register the specified Azure target as a replication target for the BlackPearl system.

Requests

Syntax

POST http[s]://{datapathDNSname}/_rest_/azure_target​?account_key={string}&account_name={string}​&name={string}​[&auto_verify_freqency_in_days={integer}][&cloud_bucket_prefix={string}​]​[&cloud_bucket_suffix={string}​]​[&default_read_preference=MINIMUM_LATENCY|AFTER_ONLINE_POOL|​AFTER_NEARLINE_POOL|AFTER_NON_EJECTABLE_TAPE|LAST_RESORT|NEVER]​[&https={string}][&permit_going_out_of_sync=TRUE|FALSE]​

Request Parameters 

Parameter	Description	Required
account_key	Enter the account key associated with the account name below.	yes
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.	yes
name	The name for the Azure target.	yes
auto_verify_ frequency_in_days	The frequency at which a full verify of the data on the target is scheduled. If null (default), 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.	no
cloud_bucket_ prefix	The Azure target bucket (blob storage container) prefix. The prefix must adhere to the Azure naming requirements. Bucket names on the BlackPearl system must be unique within the 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.	no
cloud_bucket_ suffix	The Azure target bucket (blob storage container) suffix. The suffix must adhere to the Azure naming requirements. Bucket names on the BlackPearl system must be unique within the 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.	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 (default), FALSE.	no
permit_going_out_of_sync	Whether a target is allowed to be out of sync with the source. By default, if the data policy specifies that the BlackPearl system must replicate local actions, actions that the system cannot replicate fail. You can temporarily set this parameter to TRUE in order to operate in full capacity locally while one or more targets is down for a prolonged period of time. Values: TRUE, FALSE (default) Note: This parameter is deprecated.	no

Responses

Response Elements

<Data>
   <AccountKey>{string}</AccountKey>

   <AccountName>{string}</AccountName>

   <AutoVerifyFrequencyInDays>{string}</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>
</Data>

where the response elements are defined as follows:

Parameter	Description
Data	The container for the response.
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 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 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 registers an Azure target with the Administrator S3 Access Id ‘BackupAdmin’, the Administrator S3 Secret Key ‘d7pJBeAN’, and the name ‘TargetAzure’ to use a default read preference of MINIMUM_LATENCY as a replication target for the BlackPearl system.

POST http[s]://blackpearl-hostname/_rest_/azure_target​?account_name=Backupdmin&account_key=d7pJBeAN​&name=TargetAzure&default_read_preference=MINIMUM_LATENCY HTTP/1.1

Sample Response

HTTP/1.1 201 CREATED
<Data>

   <AccountKey>d7pJBeAN​</AccountKey>

   <AccountName>BackupAdmin</AccountName>

   <AutoVerifyFrequencyInDays/>

   <CloudBucketPrefix/>

   <CloudBucketSuffix/>

   <DefaultReadPreference>MINIMUM_LATENCY</DefaultReadPreference>

   <Https>TRUE</Https>

   <Id>3918b938-05e2-482b-b010-bdb24e2283f7</Id>

   <LastFullyVerified/>

   <Name>TargetAzure</Name>

   <PermitGoingOutOfSync>FALSE</PermitGoingOutOfSync>

   <Quiesced>NO</Quiesced>

   <State>ONLINE</State>

</Data>