CreateLocationAzureBlobCommand

Suggest an Edit

Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.

Before you begin, make sure you know how DataSync accesses Azure Blob Storage  and works with access tiers  and blob types . You also need a DataSync agent  that can connect to your container.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, CreateLocationAzureBlobCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, CreateLocationAzureBlobCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // CreateLocationAzureBlobRequest
  ContainerUrl: "STRING_VALUE", // required
  AuthenticationType: "SAS", // required
  SasConfiguration: { // AzureBlobSasConfiguration
    Token: "STRING_VALUE", // required
  },
  BlobType: "BLOCK",
  AccessTier: "HOT" || "COOL" || "ARCHIVE",
  Subdirectory: "STRING_VALUE",
  AgentArns: [ // AgentArnList // required
    "STRING_VALUE",
  ],
  Tags: [ // InputTagList
    { // TagListEntry
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreateLocationAzureBlobCommand(input);
const response = await client.send(command);
// { // CreateLocationAzureBlobResponse
//   LocationArn: "STRING_VALUE",
// };

CreateLocationAzureBlobCommand Input

See CreateLocationAzureBlobCommandInput for more details

Parameter
Type
Description
AgentArns
Required
string[] | undefined

Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.

You can specify more than one agent. For more information, see Using multiple agents for your transfer .

AuthenticationType
Required
AzureBlobAuthenticationType | undefined

Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

ContainerUrl
Required
string | undefined

Specifies the URL of the Azure Blob Storage container involved in your transfer.

AccessTier
AzureAccessTier | undefined

Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers .

BlobType
AzureBlobType | undefined

Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation .

SasConfiguration
AzureBlobSasConfiguration | undefined

Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

Subdirectory
string | undefined

Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

Tags
TagListEntry[] | undefined

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.

CreateLocationAzureBlobCommand Output

See CreateLocationAzureBlobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LocationArn
string | undefined

The ARN of the Azure Blob Storage transfer location that you created.

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.