Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-AzStorageSyncServerEndpoint
- Module:
- Az.StorageSync Module
This command allows for changes on the adjustable parameters of a server endpoint.
Syntax
StringParameterSet (Default)
Set-AzStorageSyncServerEndpoint
[-ResourceGroupName] <String>
[-StorageSyncServiceName] <String>
[-SyncGroupName] <String>
[-Name] <String>
[-CloudTiering]
[-VolumeFreeSpacePercent <Int32>]
[-OfflineDataTransfer]
[-TierFilesOlderThanDays <Int32>]
[-LocalCacheMode <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdParameterSet
Set-AzStorageSyncServerEndpoint
[-ResourceId] <String>
[-CloudTiering]
[-VolumeFreeSpacePercent <Int32>]
[-OfflineDataTransfer]
[-TierFilesOlderThanDays <Int32>]
[-LocalCacheMode <String>]
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ObjectParameterSet
Set-AzStorageSyncServerEndpoint
[-InputObject] <PSServerEndpoint>
[-CloudTiering]
[-VolumeFreeSpacePercent <Int32>]
[-OfflineDataTransfer]
[-TierFilesOlderThanDays <Int32>]
[-LocalCacheMode <String>]
[-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
Set-AzStorageSyncServerEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName" -Name "myServerEndpointName" -TierFilesOlderThanDays 30
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
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CloudTiering
Cloud Tiering Parameter
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
-InputObject
SyncGroup Object, normally passed through the parameter.
Parameter properties
| Type: | PSServerEndpoint |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ServerEndpoint |
Parameter sets
-LocalCacheMode
Local cache mode Parameter
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | DownloadNewAndModifiedFiles, UpdateLocallyCachedFiles |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
Name of the ServerEndpoint.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ServerEndpointName |
Parameter sets
-OfflineDataTransfer
Cloud Seeded Data Parameter.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
Resource Group Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceId
ServerEndpoint Resource Id
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-StorageSyncServiceName
Name of the StorageSyncService.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ParentName |
Parameter sets
-SyncGroupName
Name of the SyncGroup.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TierFilesOlderThanDays
Tier Files Older Than Days Parameter
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VolumeFreeSpacePercent
Volume Free Space Percent Parameter
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
PSServerEndpoint
Outputs
PSServerEndpoint
Azure PowerShell
Feedback
Was this page helpful?
