Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/preliminary/azure_storage/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Azure Storage",
"position": 4
}
20 changes: 20 additions & 0 deletions docs/preliminary/azure_storage/azure-account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_position: 4
title: Creating a Microsoft Azure Account
---

If you don’t already have a Microsoft Account:

- Visit: https://azure.microsoft.com/en-us/free/
- Choose the Free Tier to start; it becomes pay-as-you-go after the trial period.
A credit card is required for identity verification, but no charges apply unless usage exceeds the free limits.

<figure>
<img src="/img/azure/azure-signup-profile.png" />
<figcaption>Add your profile details</figcaption>
</figure>

<figure>
<img src="/img/azure/azure-signup-credit.png" />
<figcaption>Add your credit card details</figcaption>
</figure>
37 changes: 37 additions & 0 deletions docs/preliminary/azure_storage/azure-container.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_position: 6
title: Azure Container Creation
---

### Create a Blob Storage Container

At this point we now need a place to put the files. As the [Microsoft documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/blob-containers-portal) states "Azure Blob Storage allows you to store large amounts of unstructured object data." This will be where the AI-READI files will be ultimately delivered. If you already have a container you can skip to the next step to [create a SAS token](./azure-token.mdx).

1. In the Azure Portal, go to "Storage accounts" and click your storage account.
2. In the left sidebar under "Data storage", click "Containers".

<figure>
<img src="/img/azure/azure-container-1.png" />
<figcaption>Containers menu item</figcaption>
</figure>

3. Click "+ Add Container" tab.

<figure>
<img src="/img/azure/azure-container-2.png" />
<figcaption>Tab to create container</figcaption>
</figure>

4. Set the container details

- **Name**: Must be lowercase, no spaces.
- **Public access level**: Select "Private (no anonymous access)".

<figure>
<img src="/img/azure/azure-container-3.png" />
<figcaption>Tab to create container</figcaption>
</figure>

5. Click the "Create" button.

**Note**: Save your Container Name along with the Storage Account name for use in the dataset request.
55 changes: 55 additions & 0 deletions docs/preliminary/azure_storage/azure-storage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
sidebar_position: 5
title: Azure Storage Account Creation
---

### Create an Azure Storage Account

Next, create an [Azure Storage Account](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview) that will house the storage container. Below is a summarized version of the [full documentation](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create). If you already have an Azure Storage Account you can [skip to creating the container](./azure-container.mdx).

1. Log in to the Azure Portal: https://portal.azure.com
2. Search for "Storage accounts" in the top search bar and click "+ Create".

{' '}

<figure>
<img src="/img/azure/azure-storage-1.png" />
<figcaption>Locate the Storage account item from the menu in the upper left</figcaption>
</figure>

3. Fill out the form:

- **Subscription**: Select your plan.
- **Resource group**: Use an existing one or create a new one.
- **Storage account name**: Choose a globally unique, lowercase name.
- **Region**: Choose a region closest to you.
- **Performance**: Standard (default).
- **Redundancy**: Locally-redundant storage (LRS) is recommended.

<figure>
<img src="/img/azure/azure-storage-2.png" />
<figcaption>Form elements to complete</figcaption>
</figure>

4. Click "Review + create", then "Create".

**Note**: Take note of your Storage Account Name. You’ll need this when requesting the dataset.

{' '}

<figure>
<img src="/img/azure/azure-storage-3.png" />
<figcaption>Review the details</figcaption>
</figure>
<figure>
<img src="/img/azure/azure-storage-4.png" />
<figcaption>Overview while the storage account is created</figcaption>
</figure>
<figure>
<img src="/img/azure/azure-storage-5.png" />
<figcaption>Once complete you can go to the storage account</figcaption>
</figure>
<figure>
<img src="/img/azure/azure-container-1.png" />
<figcaption>Storage account home page</figcaption>
</figure>
53 changes: 53 additions & 0 deletions docs/preliminary/azure_storage/azure-token.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
sidebar_position: 7
title: Azure Container SAS Token Generation
description: Instructions for generating a SAS token for an Azure Blob Storage container.
---

### Generate a SAS Token

Now that we have a Storage Account and a Blob Container, create a Shared Access Signature (SAS) token. This token will allow the AI-READI pipeline to write files to your container. See the [Microsoft documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/blob-containers-portal#generate-a-shared-access-signature) for more details.

1. From the container, expand the "Settings" menu item and select "Shared access tokens".

<figure>
<img src="/img/azure/azure-token-6.png" />
<figcaption>Access container settings</figcaption>
</figure>

2. Set the following options:

- **Permissions**: Check only the box for "Write".

<figure>
<img src="/img/azure/azure-token-8.png" />
<figcaption>Set the token permissions</figcaption>
</figure>

- **Expiry**: Choose a date several weeks or months in the future (e.g., 2 to 3 weeks).
<figure>
<img src="/img/azure/azure-token-9.png" />
<figcaption>Set the token exipration date</figcaption>
</figure>

3. Click "**Generate SAS token and URL**".

<figure>
<img src="/img/azure/azure-token-10.png" />
</figure>

4. Copy only the "Blob SAS token". It will be in the following format:

_`sp=w&st=2025-06-02T23:28:30Z&se=2025-07-04T07:28:30Z&spr=https&sv=2024-11-04&sr=c sig=KBj2FOV...`_

**Important**: Only submit the SAS token (do not include the full SAS URL).

### Final Checklist

Make sure you have all three of the following:

- Storage Account Name
- Blob Container Name
- Blob SAS Token (Write permission)

Provide this information while requesting access to the AI-READI dataset during the Azure credentials step.
12 changes: 12 additions & 0 deletions docs/preliminary/azure_storage/azure.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
sidebar_position: 1
title: Azure Storage Overview
---

Due to the size of the AI-READI dataset, we require requestors to provide an Azure storage container to receive the processed data. Specifically, at the end of the request process you will need to provide:

1. Storage Account Name
1. Blob Container Name
1. Blob SAS Token (with "Write" permission only)

Follow the steps over the next few pages to create your Azure storage environment. Please do this before you attempt to request the AI-READI dataset as it can lead to delays in processing your request.
Binary file added static/img/azure/azure-container-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-container-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-container-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-signup-credit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-signup-profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-storage-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-storage-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-storage-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-storage-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-storage-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-token-10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-token-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-token-8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/azure/azure-token-9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.