1. Packages
  2. Azure Classic
  3. API Docs
  4. storage
  5. SyncServerEndpoint

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.storage.SyncServerEndpoint

Explore with Pulumi AI

Manages a Storage Sync Server Endpoint.

NOTE: The parent azure.storage.SyncGroup must have an azure.storage.SyncCloudEndpoint available before an azure.storage.SyncServerEndpoint resource can be created.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleSync = new azure.storage.Sync("example", {
    name: "example-storage-sync",
    resourceGroupName: example.name,
    location: example.location,
});
const exampleSyncGroup = new azure.storage.SyncGroup("example", {
    name: "example-storage-sync-group",
    storageSyncId: exampleSync.id,
});
const exampleAccount = new azure.storage.Account("example", {
    name: "example-storage-account",
    resourceGroupName: example.name,
    location: example.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleShare = new azure.storage.Share("example", {
    name: "example-storage-share",
    storageAccountName: exampleAccount.name,
    quota: 1,
    acls: [{
        id: "GhostedRecall",
        accessPolicies: [{
            permissions: "r",
        }],
    }],
});
const exampleSyncCloudEndpoint = new azure.storage.SyncCloudEndpoint("example", {
    name: "example-ss-ce",
    storageSyncGroupId: exampleSyncGroup.id,
    fileShareName: exampleShare.name,
    storageAccountId: exampleAccount.id,
});
const exampleSyncServerEndpoint = new azure.storage.SyncServerEndpoint("example", {
    name: "example-storage-sync-server-endpoint",
    storageSyncGroupId: exampleSyncGroup.id,
    registeredServerId: exampleSync.registeredServers[0],
}, {
    dependsOn: [exampleSyncCloudEndpoint],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_sync = azure.storage.Sync("example",
    name="example-storage-sync",
    resource_group_name=example.name,
    location=example.location)
example_sync_group = azure.storage.SyncGroup("example",
    name="example-storage-sync-group",
    storage_sync_id=example_sync.id)
example_account = azure.storage.Account("example",
    name="example-storage-account",
    resource_group_name=example.name,
    location=example.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_share = azure.storage.Share("example",
    name="example-storage-share",
    storage_account_name=example_account.name,
    quota=1,
    acls=[{
        "id": "GhostedRecall",
        "access_policies": [{
            "permissions": "r",
        }],
    }])
example_sync_cloud_endpoint = azure.storage.SyncCloudEndpoint("example",
    name="example-ss-ce",
    storage_sync_group_id=example_sync_group.id,
    file_share_name=example_share.name,
    storage_account_id=example_account.id)
example_sync_server_endpoint = azure.storage.SyncServerEndpoint("example",
    name="example-storage-sync-server-endpoint",
    storage_sync_group_id=example_sync_group.id,
    registered_server_id=example_sync.registered_servers[0],
    opts = pulumi.ResourceOptions(depends_on=[example_sync_cloud_endpoint]))
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleSync, err := storage.NewSync(ctx, "example", &storage.SyncArgs{
			Name:              pulumi.String("example-storage-sync"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		exampleSyncGroup, err := storage.NewSyncGroup(ctx, "example", &storage.SyncGroupArgs{
			Name:          pulumi.String("example-storage-sync-group"),
			StorageSyncId: exampleSync.ID(),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("example-storage-account"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleShare, err := storage.NewShare(ctx, "example", &storage.ShareArgs{
			Name:               pulumi.String("example-storage-share"),
			StorageAccountName: exampleAccount.Name,
			Quota:              pulumi.Int(1),
			Acls: storage.ShareAclArray{
				&storage.ShareAclArgs{
					Id: pulumi.String("GhostedRecall"),
					AccessPolicies: storage.ShareAclAccessPolicyArray{
						&storage.ShareAclAccessPolicyArgs{
							Permissions: pulumi.String("r"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		exampleSyncCloudEndpoint, err := storage.NewSyncCloudEndpoint(ctx, "example", &storage.SyncCloudEndpointArgs{
			Name:               pulumi.String("example-ss-ce"),
			StorageSyncGroupId: exampleSyncGroup.ID(),
			FileShareName:      exampleShare.Name,
			StorageAccountId:   exampleAccount.ID(),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewSyncServerEndpoint(ctx, "example", &storage.SyncServerEndpointArgs{
			Name:               pulumi.String("example-storage-sync-server-endpoint"),
			StorageSyncGroupId: exampleSyncGroup.ID(),
			RegisteredServerId: exampleSync.RegisteredServers.ApplyT(func(registeredServers []string) (string, error) {
				return registeredServers[0], nil
			}).(pulumi.StringOutput),
		}, pulumi.DependsOn([]pulumi.Resource{
			exampleSyncCloudEndpoint,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleSync = new Azure.Storage.Sync("example", new()
    {
        Name = "example-storage-sync",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var exampleSyncGroup = new Azure.Storage.SyncGroup("example", new()
    {
        Name = "example-storage-sync-group",
        StorageSyncId = exampleSync.Id,
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "example-storage-account",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
    });

    var exampleShare = new Azure.Storage.Share("example", new()
    {
        Name = "example-storage-share",
        StorageAccountName = exampleAccount.Name,
        Quota = 1,
        Acls = new[]
        {
            new Azure.Storage.Inputs.ShareAclArgs
            {
                Id = "GhostedRecall",
                AccessPolicies = new[]
                {
                    new Azure.Storage.Inputs.ShareAclAccessPolicyArgs
                    {
                        Permissions = "r",
                    },
                },
            },
        },
    });

    var exampleSyncCloudEndpoint = new Azure.Storage.SyncCloudEndpoint("example", new()
    {
        Name = "example-ss-ce",
        StorageSyncGroupId = exampleSyncGroup.Id,
        FileShareName = exampleShare.Name,
        StorageAccountId = exampleAccount.Id,
    });

    var exampleSyncServerEndpoint = new Azure.Storage.SyncServerEndpoint("example", new()
    {
        Name = "example-storage-sync-server-endpoint",
        StorageSyncGroupId = exampleSyncGroup.Id,
        RegisteredServerId = exampleSync.RegisteredServers.Apply(registeredServers => registeredServers[0]),
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            exampleSyncCloudEndpoint,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Sync;
import com.pulumi.azure.storage.SyncArgs;
import com.pulumi.azure.storage.SyncGroup;
import com.pulumi.azure.storage.SyncGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Share;
import com.pulumi.azure.storage.ShareArgs;
import com.pulumi.azure.storage.inputs.ShareAclArgs;
import com.pulumi.azure.storage.SyncCloudEndpoint;
import com.pulumi.azure.storage.SyncCloudEndpointArgs;
import com.pulumi.azure.storage.SyncServerEndpoint;
import com.pulumi.azure.storage.SyncServerEndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleSync = new Sync("exampleSync", SyncArgs.builder()
            .name("example-storage-sync")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var exampleSyncGroup = new SyncGroup("exampleSyncGroup", SyncGroupArgs.builder()
            .name("example-storage-sync-group")
            .storageSyncId(exampleSync.id())
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example-storage-account")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .build());

        var exampleShare = new Share("exampleShare", ShareArgs.builder()
            .name("example-storage-share")
            .storageAccountName(exampleAccount.name())
            .quota(1)
            .acls(ShareAclArgs.builder()
                .id("GhostedRecall")
                .accessPolicies(ShareAclAccessPolicyArgs.builder()
                    .permissions("r")
                    .build())
                .build())
            .build());

        var exampleSyncCloudEndpoint = new SyncCloudEndpoint("exampleSyncCloudEndpoint", SyncCloudEndpointArgs.builder()
            .name("example-ss-ce")
            .storageSyncGroupId(exampleSyncGroup.id())
            .fileShareName(exampleShare.name())
            .storageAccountId(exampleAccount.id())
            .build());

        var exampleSyncServerEndpoint = new SyncServerEndpoint("exampleSyncServerEndpoint", SyncServerEndpointArgs.builder()
            .name("example-storage-sync-server-endpoint")
            .storageSyncGroupId(exampleSyncGroup.id())
            .registeredServerId(exampleSync.registeredServers().applyValue(registeredServers -> registeredServers[0]))
            .build(), CustomResourceOptions.builder()
                .dependsOn(exampleSyncCloudEndpoint)
                .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleSync:
    type: azure:storage:Sync
    name: example
    properties:
      name: example-storage-sync
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleSyncGroup:
    type: azure:storage:SyncGroup
    name: example
    properties:
      name: example-storage-sync-group
      storageSyncId: ${exampleSync.id}
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: example-storage-account
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountTier: Standard
      accountReplicationType: LRS
  exampleShare:
    type: azure:storage:Share
    name: example
    properties:
      name: example-storage-share
      storageAccountName: ${exampleAccount.name}
      quota: 1
      acls:
        - id: GhostedRecall
          accessPolicies:
            - permissions: r
  exampleSyncCloudEndpoint:
    type: azure:storage:SyncCloudEndpoint
    name: example
    properties:
      name: example-ss-ce
      storageSyncGroupId: ${exampleSyncGroup.id}
      fileShareName: ${exampleShare.name}
      storageAccountId: ${exampleAccount.id}
  exampleSyncServerEndpoint:
    type: azure:storage:SyncServerEndpoint
    name: example
    properties:
      name: example-storage-sync-server-endpoint
      storageSyncGroupId: ${exampleSyncGroup.id}
      registeredServerId: ${exampleSync.registeredServers[0]}
    options:
      dependsOn:
        - ${exampleSyncCloudEndpoint}
Copy

Create SyncServerEndpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SyncServerEndpoint(name: string, args: SyncServerEndpointArgs, opts?: CustomResourceOptions);
@overload
def SyncServerEndpoint(resource_name: str,
                       args: SyncServerEndpointArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def SyncServerEndpoint(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       registered_server_id: Optional[str] = None,
                       server_local_path: Optional[str] = None,
                       storage_sync_group_id: Optional[str] = None,
                       cloud_tiering_enabled: Optional[bool] = None,
                       initial_download_policy: Optional[str] = None,
                       local_cache_mode: Optional[str] = None,
                       name: Optional[str] = None,
                       tier_files_older_than_days: Optional[int] = None,
                       volume_free_space_percent: Optional[int] = None)
func NewSyncServerEndpoint(ctx *Context, name string, args SyncServerEndpointArgs, opts ...ResourceOption) (*SyncServerEndpoint, error)
public SyncServerEndpoint(string name, SyncServerEndpointArgs args, CustomResourceOptions? opts = null)
public SyncServerEndpoint(String name, SyncServerEndpointArgs args)
public SyncServerEndpoint(String name, SyncServerEndpointArgs args, CustomResourceOptions options)
type: azure:storage:SyncServerEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SyncServerEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SyncServerEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SyncServerEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SyncServerEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SyncServerEndpointArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var syncServerEndpointResource = new Azure.Storage.SyncServerEndpoint("syncServerEndpointResource", new()
{
    RegisteredServerId = "string",
    ServerLocalPath = "string",
    StorageSyncGroupId = "string",
    CloudTieringEnabled = false,
    InitialDownloadPolicy = "string",
    LocalCacheMode = "string",
    Name = "string",
    TierFilesOlderThanDays = 0,
    VolumeFreeSpacePercent = 0,
});
Copy
example, err := storage.NewSyncServerEndpoint(ctx, "syncServerEndpointResource", &storage.SyncServerEndpointArgs{
	RegisteredServerId:     pulumi.String("string"),
	ServerLocalPath:        pulumi.String("string"),
	StorageSyncGroupId:     pulumi.String("string"),
	CloudTieringEnabled:    pulumi.Bool(false),
	InitialDownloadPolicy:  pulumi.String("string"),
	LocalCacheMode:         pulumi.String("string"),
	Name:                   pulumi.String("string"),
	TierFilesOlderThanDays: pulumi.Int(0),
	VolumeFreeSpacePercent: pulumi.Int(0),
})
Copy
var syncServerEndpointResource = new SyncServerEndpoint("syncServerEndpointResource", SyncServerEndpointArgs.builder()
    .registeredServerId("string")
    .serverLocalPath("string")
    .storageSyncGroupId("string")
    .cloudTieringEnabled(false)
    .initialDownloadPolicy("string")
    .localCacheMode("string")
    .name("string")
    .tierFilesOlderThanDays(0)
    .volumeFreeSpacePercent(0)
    .build());
Copy
sync_server_endpoint_resource = azure.storage.SyncServerEndpoint("syncServerEndpointResource",
    registered_server_id="string",
    server_local_path="string",
    storage_sync_group_id="string",
    cloud_tiering_enabled=False,
    initial_download_policy="string",
    local_cache_mode="string",
    name="string",
    tier_files_older_than_days=0,
    volume_free_space_percent=0)
Copy
const syncServerEndpointResource = new azure.storage.SyncServerEndpoint("syncServerEndpointResource", {
    registeredServerId: "string",
    serverLocalPath: "string",
    storageSyncGroupId: "string",
    cloudTieringEnabled: false,
    initialDownloadPolicy: "string",
    localCacheMode: "string",
    name: "string",
    tierFilesOlderThanDays: 0,
    volumeFreeSpacePercent: 0,
});
Copy
type: azure:storage:SyncServerEndpoint
properties:
    cloudTieringEnabled: false
    initialDownloadPolicy: string
    localCacheMode: string
    name: string
    registeredServerId: string
    serverLocalPath: string
    storageSyncGroupId: string
    tierFilesOlderThanDays: 0
    volumeFreeSpacePercent: 0
Copy

SyncServerEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SyncServerEndpoint resource accepts the following input properties:

RegisteredServerId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

ServerLocalPath
This property is required.
Changes to this property will trigger replacement.
string
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
StorageSyncGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
CloudTieringEnabled bool
Is Cloud Tiering Enabled? Defaults to false.
InitialDownloadPolicy Changes to this property will trigger replacement. string
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
LocalCacheMode string
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
TierFilesOlderThanDays int
Files older than the specified age will be tiered to the cloud.
VolumeFreeSpacePercent int
What percentage of free space on the volume should be preserved? Defaults to 20.
RegisteredServerId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

ServerLocalPath
This property is required.
Changes to this property will trigger replacement.
string
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
StorageSyncGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
CloudTieringEnabled bool
Is Cloud Tiering Enabled? Defaults to false.
InitialDownloadPolicy Changes to this property will trigger replacement. string
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
LocalCacheMode string
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
TierFilesOlderThanDays int
Files older than the specified age will be tiered to the cloud.
VolumeFreeSpacePercent int
What percentage of free space on the volume should be preserved? Defaults to 20.
registeredServerId
This property is required.
Changes to this property will trigger replacement.
String

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

serverLocalPath
This property is required.
Changes to this property will trigger replacement.
String
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storageSyncGroupId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
cloudTieringEnabled Boolean
Is Cloud Tiering Enabled? Defaults to false.
initialDownloadPolicy Changes to this property will trigger replacement. String
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
localCacheMode String
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
tierFilesOlderThanDays Integer
Files older than the specified age will be tiered to the cloud.
volumeFreeSpacePercent Integer
What percentage of free space on the volume should be preserved? Defaults to 20.
registeredServerId
This property is required.
Changes to this property will trigger replacement.
string

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

serverLocalPath
This property is required.
Changes to this property will trigger replacement.
string
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storageSyncGroupId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
cloudTieringEnabled boolean
Is Cloud Tiering Enabled? Defaults to false.
initialDownloadPolicy Changes to this property will trigger replacement. string
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
localCacheMode string
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. string
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
tierFilesOlderThanDays number
Files older than the specified age will be tiered to the cloud.
volumeFreeSpacePercent number
What percentage of free space on the volume should be preserved? Defaults to 20.
registered_server_id
This property is required.
Changes to this property will trigger replacement.
str

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

server_local_path
This property is required.
Changes to this property will trigger replacement.
str
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storage_sync_group_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
cloud_tiering_enabled bool
Is Cloud Tiering Enabled? Defaults to false.
initial_download_policy Changes to this property will trigger replacement. str
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
local_cache_mode str
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. str
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
tier_files_older_than_days int
Files older than the specified age will be tiered to the cloud.
volume_free_space_percent int
What percentage of free space on the volume should be preserved? Defaults to 20.
registeredServerId
This property is required.
Changes to this property will trigger replacement.
String

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

serverLocalPath
This property is required.
Changes to this property will trigger replacement.
String
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storageSyncGroupId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
cloudTieringEnabled Boolean
Is Cloud Tiering Enabled? Defaults to false.
initialDownloadPolicy Changes to this property will trigger replacement. String
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
localCacheMode String
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
tierFilesOlderThanDays Number
Files older than the specified age will be tiered to the cloud.
volumeFreeSpacePercent Number
What percentage of free space on the volume should be preserved? Defaults to 20.

Outputs

All input properties are implicitly available as output properties. Additionally, the SyncServerEndpoint resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing SyncServerEndpoint Resource

Get an existing SyncServerEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SyncServerEndpointState, opts?: CustomResourceOptions): SyncServerEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_tiering_enabled: Optional[bool] = None,
        initial_download_policy: Optional[str] = None,
        local_cache_mode: Optional[str] = None,
        name: Optional[str] = None,
        registered_server_id: Optional[str] = None,
        server_local_path: Optional[str] = None,
        storage_sync_group_id: Optional[str] = None,
        tier_files_older_than_days: Optional[int] = None,
        volume_free_space_percent: Optional[int] = None) -> SyncServerEndpoint
func GetSyncServerEndpoint(ctx *Context, name string, id IDInput, state *SyncServerEndpointState, opts ...ResourceOption) (*SyncServerEndpoint, error)
public static SyncServerEndpoint Get(string name, Input<string> id, SyncServerEndpointState? state, CustomResourceOptions? opts = null)
public static SyncServerEndpoint get(String name, Output<String> id, SyncServerEndpointState state, CustomResourceOptions options)
resources:  _:    type: azure:storage:SyncServerEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CloudTieringEnabled bool
Is Cloud Tiering Enabled? Defaults to false.
InitialDownloadPolicy Changes to this property will trigger replacement. string
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
LocalCacheMode string
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
RegisteredServerId Changes to this property will trigger replacement. string

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

ServerLocalPath Changes to this property will trigger replacement. string
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
StorageSyncGroupId Changes to this property will trigger replacement. string
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
TierFilesOlderThanDays int
Files older than the specified age will be tiered to the cloud.
VolumeFreeSpacePercent int
What percentage of free space on the volume should be preserved? Defaults to 20.
CloudTieringEnabled bool
Is Cloud Tiering Enabled? Defaults to false.
InitialDownloadPolicy Changes to this property will trigger replacement. string
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
LocalCacheMode string
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
RegisteredServerId Changes to this property will trigger replacement. string

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

ServerLocalPath Changes to this property will trigger replacement. string
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
StorageSyncGroupId Changes to this property will trigger replacement. string
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
TierFilesOlderThanDays int
Files older than the specified age will be tiered to the cloud.
VolumeFreeSpacePercent int
What percentage of free space on the volume should be preserved? Defaults to 20.
cloudTieringEnabled Boolean
Is Cloud Tiering Enabled? Defaults to false.
initialDownloadPolicy Changes to this property will trigger replacement. String
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
localCacheMode String
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
registeredServerId Changes to this property will trigger replacement. String

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

serverLocalPath Changes to this property will trigger replacement. String
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storageSyncGroupId Changes to this property will trigger replacement. String
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
tierFilesOlderThanDays Integer
Files older than the specified age will be tiered to the cloud.
volumeFreeSpacePercent Integer
What percentage of free space on the volume should be preserved? Defaults to 20.
cloudTieringEnabled boolean
Is Cloud Tiering Enabled? Defaults to false.
initialDownloadPolicy Changes to this property will trigger replacement. string
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
localCacheMode string
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. string
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
registeredServerId Changes to this property will trigger replacement. string

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

serverLocalPath Changes to this property will trigger replacement. string
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storageSyncGroupId Changes to this property will trigger replacement. string
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
tierFilesOlderThanDays number
Files older than the specified age will be tiered to the cloud.
volumeFreeSpacePercent number
What percentage of free space on the volume should be preserved? Defaults to 20.
cloud_tiering_enabled bool
Is Cloud Tiering Enabled? Defaults to false.
initial_download_policy Changes to this property will trigger replacement. str
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
local_cache_mode str
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. str
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
registered_server_id Changes to this property will trigger replacement. str

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

server_local_path Changes to this property will trigger replacement. str
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storage_sync_group_id Changes to this property will trigger replacement. str
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
tier_files_older_than_days int
Files older than the specified age will be tiered to the cloud.
volume_free_space_percent int
What percentage of free space on the volume should be preserved? Defaults to 20.
cloudTieringEnabled Boolean
Is Cloud Tiering Enabled? Defaults to false.
initialDownloadPolicy Changes to this property will trigger replacement. String
Specifies how the server initially downloads the Azure file share data. Valid Values includes NamespaceThenModifiedFiles, NamespaceOnly, and AvoidTieredFiles. Defaults to NamespaceThenModifiedFiles.
localCacheMode String
Specifies how to handle the local cache. Valid Values include UpdateLocallyCachedFiles and DownloadNewAndModifiedFiles. Defaults to UpdateLocallyCachedFiles.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Sync. Changing this forces a new Storage Sync Server Endpoint to be created.
registeredServerId Changes to this property will trigger replacement. String

The ID of the Registered Server that will be associate with the Storage Sync Server Endpoint. Changing this forces a new Storage Sync Server Endpoint to be created.

NOTE: The target server must already be registered with the parent azure.storage.Sync prior to creating this endpoint. For more information on registering a server see the Microsoft documentation

serverLocalPath Changes to this property will trigger replacement. String
The path on the Windows Server to be synced to the Azure file share. Changing this forces a new Storage Sync Server Endpoint to be created.
storageSyncGroupId Changes to this property will trigger replacement. String
The ID of the Storage Sync Group where the Storage Sync Server Endpoint should exist. Changing this forces a new Storage Sync Server Endpoint to be created.
tierFilesOlderThanDays Number
Files older than the specified age will be tiered to the cloud.
volumeFreeSpacePercent Number
What percentage of free space on the volume should be preserved? Defaults to 20.

Import

Storage Sync Server Endpoints can be imported using the resource id, e.g.

$ pulumi import azure:storage/syncServerEndpoint:SyncServerEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.StorageSync/storageSyncServices/sync1/syncGroups/syncGroup1/serverEndpoints/endpoint1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.