DataSync / Client / create_location_azure_blob

create_location_azure_blob#

DataSync.Client.create_location_azure_blob(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_location_azure_blob(
    ContainerUrl='string',
    AuthenticationType='SAS',
    SasConfiguration={
        'Token': 'string'
    },
    BlobType='BLOCK',
    AccessTier='HOT'|'COOL'|'ARCHIVE',
    Subdirectory='string',
    AgentArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ContainerUrl (string) –

    [REQUIRED]

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

  • AuthenticationType (string) –

    [REQUIRED]

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

  • SasConfiguration (dict) –

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

    • Token (string) – [REQUIRED]

      Specifies a SAS token that provides permissions to access your Azure Blob Storage.

      The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

      sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D

  • BlobType (string) – 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.

  • AccessTier (string) – 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.

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

  • AgentArns (list) –

    [REQUIRED]

    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.

    • (string) –

  • Tags (list) –

    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.

    • (dict) –

      A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

      • Key (string) – [REQUIRED]

        The key for an Amazon Web Services resource tag.

      • Value (string) –

        The value for an Amazon Web Services resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) –

    • LocationArn (string) –

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

Exceptions