---
title: "Set-VBRAzureArchiveRepository"
description: "This cmdlet modifies the settings for an Azure Archive repository added to the backup infrastructure. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrazurearchiverepository.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Backup Infrastructure > Object Storage Repositories > Adding Microsoft Azure Object Storage > Set-VBRAzureArchiveRepository"
dateModified: "2026-08-19"
---

# Set-VBRAzureArchiveRepository

## Short Description
Modifies settings for Azure Archive repository added to the backup infrastructure.

**Platform**: VMware, Hyper-V

**Product Edition**: Enterprise, Enterprise Plus, Veeam Universal License

## Syntax
```
Set-VBRAzureArchiveRepository -Repository <VBRAzureArchiveRepository> [-Name <String>] [-Description <String>]
 [-AzureProxySpec <VBRAzureComputeProxyAppliance>] [-UseInstantRetrieval] [-UseGatewayServer]
 [-GatewayServer <CHost[]>] [-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]
 [-ConnectionType <VBRRepositoryConnectionType>] [-Force] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies the settings for an Azure Archive repository added to the backup infrastructure.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">AzureProxySpec</span></p>
        </td>
        <td>
          <p>Specifies a proxy appliance for transferring the data.</p><p>Accepts the <code>VBRAzureComputeProxyAppliance</code> object. To create this object, run the <a href="new-vbrazurecomputeproxyappliance.md"><code>New-VBRAzureComputeProxyAppliance</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrazurecomputeproxyappliance.md"><code>VBRAzureComputeProxyAppliance</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ConnectionType</span></p>
        </td>
        <td>
          <p>Specifies how Veeam Backup & Replication will access the object storage repository:</p><ul><li><code>Direct</code>: Use this option if you want Veeam Backup & Replication to use a proxy server to transfer data from the processed VM to object storage repositories.</li><li><code>Gateway</code>: Use this option if you want Veeam Backup & Replication to use a gateway server to transfer data from processed VM to object storage repositories. <strong>Note</strong>: Provide the <code>GatewayServer</code> parameter to specify the server.</li></ul><p>Default: <code>Direct</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRRepositoryConnectionType</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Description</span></p>
        </td>
        <td>
          <p>Specifies a new description of the Azure Archive repository.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will modify an object storage repository without showing warnings in the PowerShell console.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">GatewayServer</span></p>
        </td>
        <td>
          <p>Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHost[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ImmutabilityMode</span></p>
        </td>
        <td>
          <p>Specifies the immutability retention period:</p><ul><li><code>BackupRetention</code>: Use this option if you want the immutability period to depend on the backup job retention.</li><li><code>RepositoryRetention</code>: Use this option if you want to ignore the job retention and specify the immutability period explicitly.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRRepositoryImmutabilityMode</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ImmutabilityPeriod</span></p>
        </td>
        <td>
          <p>Defines the immutability period in days.</p><p>Default: <code>30</code> days.</p><p>Maximum: <code>999</code> days.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Name</span></p>
        </td>
        <td>
          <p>Specifies a new name for the Azure Archive repository.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Repository</span></p>
        </td>
        <td>
          <p>Specifies an Azure Archive repository that you want to modify.</p><p>Accepts the <code>VBRAzureArchiveRepository</code> object. To get this object, run the <a href="get-vbrarchiveobjectstoragerepository.md"><code>Get-VBRArchiveObjectStorageRepository</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrazurearchiverepository.md"><code>VBRAzureArchiveRepository</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">UseGatewayServer</span></p>
        </td>
        <td>
          <p><strong>Note</strong>: This parameter is deprecated and will be ignored. Use the <code>GatewayServer</code> parameter instead.</p><p>Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">UseInstantRetrieval</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will create a repository where data blocks are marked with the <em>cool</em> access tier.</p><p><strong>Note</strong>: If you do not provide the <code>UseInstantRetrieval</code> parameter, the cmdlet will create a repository where blocks are marked as the <em>archive</em> access tier.</p><p>Default: <code>False.</code></p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
This cmdlet returns `VBRAzureArchiveRepository` object that defines the Azure Archive repository settings.

## Examples

::: example
### Modifying Gateway Server of Azure Archive Repository

This example shows how to modify Azure Archive repository added to the backup infrastructure. The cmdlet will use custom gateway servers server to connect to Azure Archive repository.

```
$azure = Get-VBRArchiveObjectStorageRepository -Name "Azure"
$gateserv = Get-VBRServer -Name "north.tech.local", "north2.tech.local"
Set-VBRAzureArchiveRepository -Repository $azure -ConnectionType Gateway -GatewayServer $gateserv
```

Perform the following steps:

1. Run the [`Get-VBRArchiveObjectStorageRepository`](get-vbrarchiveobjectstoragerepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$azure` variable.
2. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$gateserv` variable.
3. Run the `Set-VBRAzureArchiveRepository` cmdlet. Set the `$azure` variable as the `Repository` parameter value. Set the `Gateway` value for the `ConnectionType` parameter. Set the `$gateserv` variable as the `GatewayServer` parameter value.

:::

## Related Commands

- [`Add-VBRAzureArchiveRepository`](add-vbrazurearchiverepository.md)
- [`Get-VBRArchiveObjectStorageRepository`](get-vbrarchiveobjectstoragerepository.md)
- [`Get-VBRServer`](get-vbrserver.md)