Set-AzStorageSyncServerEndpoint

This command allows for changes on the adjustable parameters of a server endpoint.

Syntax

Set-AzStorageSyncServerEndpoint
   [-ResourceGroupName] <String>
   [-StorageSyncServiceName] <String>
   [-SyncGroupName] <String>
   [-Name] <String>
   [-CloudTiering]
   [-VolumeFreeSpacePercent <Int32>]
   [-OfflineDataTransfer]
   [-TierFilesOlderThanDays <Int32>] [LocalCacheMode]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzStorageSyncServerEndpoint
   [-ResourceId] <String>
   [-CloudTiering]
   [-VolumeFreeSpacePercent <Int32>]
   [-OfflineDataTransfer]
   [-TierFilesOlderThanDays <Int32>] [LocalCacheMode]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzStorageSyncServerEndpoint
   [-InputObject] <PSServerEndpoint>
   [-CloudTiering]
   [-VolumeFreeSpacePercent <Int32>]
   [-OfflineDataTransfer]
   [-TierFilesOlderThanDays <Int32>] [LocalCacheMode]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This command allows for changes on the adjustable parameters of a server endpoint. For instance cloud tiering and cloud tiering policies can be changed at any time. Several aspects of a server endpoint, such as the local path, cannot be changed after the server endpoint had been created.

Examples

Example 1

PS C:\> Set-AzStorageSyncServerEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myServerEndpointName"  -TierFilesOlderThanDays 30 -OfflineDataTransfer -OfflineDataTransfer $false

This example performs two actions, it sets a new cloud tiering policy on the specified server endpoint, which directs the server to tier all files that have not been accessed in the past 30 days and it also disables the offline data transfer mode, which was initially enabled on this server endpoint during it's creation. Offline data transfer is used as part of interoperability with bulk migration services, such as Azure Data Box.

Parameters

-AsJob

Run cmdlet in the background

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CloudTiering

Cloud Tiering Parameter

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

SyncGroup Object, normally passed through the parameter.

Type:Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint
Aliases:RegisteredServer
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-localCacheMode

Local cache mode Parameter

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Name of the ServerEndpoint.

Type:String
Aliases:ServerEndpointName
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OfflineDataTransfer

Cloud Seeded Data Parameter

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceGroupName

Resource Group Name.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ResourceId

ServerEndpoint Resource Id

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-StorageSyncServiceName

Name of the StorageSyncService.

Type:String
Aliases:ParentName
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SyncGroupName

Name of the SyncGroup.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TierFilesOlderThanDays

Tier Files Older Than Days Parameter

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VolumeFreeSpacePercent

Volume Free Space Percent Parameter

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint

Outputs

Microsoft.Azure.Commands.StorageSync.Models.PSServerEndpoint