Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. storagesync
  5. StorageSyncService
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.storagesync.StorageSyncService

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Storage Sync Service object. API Version: 2020-03-01.

    Example Usage

    StorageSyncServices_Create

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var storageSyncService = new AzureNative.StorageSync.StorageSyncService("storageSyncService", new()
    {
        IncomingTrafficPolicy = "AllowAllTraffic",
        Location = "WestUS",
        ResourceGroupName = "SampleResourceGroup_1",
        StorageSyncServiceName = "SampleStorageSyncService_1",
        Tags = null,
    });

});

    package main

import (
	storagesync "github.com/pulumi/pulumi-azure-native-sdk/storagesync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagesync.NewStorageSyncService(ctx, "storageSyncService", &storagesync.StorageSyncServiceArgs{
			IncomingTrafficPolicy:  pulumi.String("AllowAllTraffic"),
			Location:               pulumi.String("WestUS"),
			ResourceGroupName:      pulumi.String("SampleResourceGroup_1"),
			StorageSyncServiceName: pulumi.String("SampleStorageSyncService_1"),
			Tags:                   nil,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storagesync.StorageSyncService;
import com.pulumi.azurenative.storagesync.StorageSyncServiceArgs;
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 storageSyncService = new StorageSyncService("storageSyncService", StorageSyncServiceArgs.builder()        
            .incomingTrafficPolicy("AllowAllTraffic")
            .location("WestUS")
            .resourceGroupName("SampleResourceGroup_1")
            .storageSyncServiceName("SampleStorageSyncService_1")
            .tags()
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

storage_sync_service = azure_native.storagesync.StorageSyncService("storageSyncService",
    incoming_traffic_policy="AllowAllTraffic",
    location="WestUS",
    resource_group_name="SampleResourceGroup_1",
    storage_sync_service_name="SampleStorageSyncService_1",
    tags={})

    import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const storageSyncService = new azure_native.storagesync.StorageSyncService("storageSyncService", {
    incomingTrafficPolicy: "AllowAllTraffic",
    location: "WestUS",
    resourceGroupName: "SampleResourceGroup_1",
    storageSyncServiceName: "SampleStorageSyncService_1",
    tags: {},
});

    resources:
  storageSyncService:
    type: azure-native:storagesync:StorageSyncService
    properties:
      incomingTrafficPolicy: AllowAllTraffic
      location: WestUS
      resourceGroupName: SampleResourceGroup_1
      storageSyncServiceName: SampleStorageSyncService_1
      tags: {}

    Create StorageSyncService Resource

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

    Constructor syntax

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

@overload
def StorageSyncService(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_group_name: Optional[str] = None,
                       incoming_traffic_policy: Optional[Union[str, IncomingTrafficPolicy]] = None,
                       location: Optional[str] = None,
                       storage_sync_service_name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewStorageSyncService(ctx *Context, name string, args StorageSyncServiceArgs, opts ...ResourceOption) (*StorageSyncService, error)
    public StorageSyncService(string name, StorageSyncServiceArgs args, CustomResourceOptions? opts = null)
    public StorageSyncService(String name, StorageSyncServiceArgs args)
public StorageSyncService(String name, StorageSyncServiceArgs args, CustomResourceOptions options)

    type: azure-native:storagesync:StorageSyncService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StorageSyncServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StorageSyncServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StorageSyncServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageSyncServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageSyncServiceArgs
    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 storageSyncServiceResource = new AzureNative.Storagesync.StorageSyncService("storageSyncServiceResource", new()
{
    ResourceGroupName = "string",
    IncomingTrafficPolicy = "string",
    Location = "string",
    StorageSyncServiceName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := storagesync.NewStorageSyncService(ctx, "storageSyncServiceResource", &storagesync.StorageSyncServiceArgs{
	ResourceGroupName:      "string",
	IncomingTrafficPolicy:  "string",
	Location:               "string",
	StorageSyncServiceName: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var storageSyncServiceResource = new StorageSyncService("storageSyncServiceResource", StorageSyncServiceArgs.builder()
    .resourceGroupName("string")
    .incomingTrafficPolicy("string")
    .location("string")
    .storageSyncServiceName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    storage_sync_service_resource = azure_native.storagesync.StorageSyncService("storageSyncServiceResource",
    resource_group_name=string,
    incoming_traffic_policy=string,
    location=string,
    storage_sync_service_name=string,
    tags={
        string: string,
    })

    const storageSyncServiceResource = new azure_native.storagesync.StorageSyncService("storageSyncServiceResource", {
    resourceGroupName: "string",
    incomingTrafficPolicy: "string",
    location: "string",
    storageSyncServiceName: "string",
    tags: {
        string: "string",
    },
});

    type: azure-native:storagesync:StorageSyncService
properties:
    incomingTrafficPolicy: string
    location: string
    resourceGroupName: string
    storageSyncServiceName: string
    tags:
        string: string

    StorageSyncService 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 StorageSyncService resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    IncomingTrafficPolicy string | Pulumi.AzureNative.StorageSync.IncomingTrafficPolicy
    Incoming Traffic Policy
    Location string
    Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    StorageSyncServiceName string
    Name of Storage Sync Service resource.
    Tags Dictionary<string, string>
    Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    IncomingTrafficPolicy string | IncomingTrafficPolicy
    Incoming Traffic Policy
    Location string
    Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    StorageSyncServiceName string
    Name of Storage Sync Service resource.
    Tags map[string]string
    Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    incomingTrafficPolicy String | IncomingTrafficPolicy
    Incoming Traffic Policy
    location String
    Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    storageSyncServiceName String
    Name of Storage Sync Service resource.
    tags Map<String,String>
    Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    incomingTrafficPolicy string | IncomingTrafficPolicy
    Incoming Traffic Policy
    location string
    Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    storageSyncServiceName string
    Name of Storage Sync Service resource.
    tags {[key: string]: string}
    Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    incoming_traffic_policy str | IncomingTrafficPolicy
    Incoming Traffic Policy
    location str
    Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    storage_sync_service_name str
    Name of Storage Sync Service resource.
    tags Mapping[str, str]
    Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    incomingTrafficPolicy String | "AllowAllTraffic" | "AllowVirtualNetworksOnly"
    Incoming Traffic Policy
    location String
    Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    storageSyncServiceName String
    Name of Storage Sync Service resource.
    tags Map<String>
    Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperationName string
    Resource Last Operation Name
    LastWorkflowId string
    StorageSyncService lastWorkflowId
    Name string
    The name of the resource
    PrivateEndpointConnections List<Pulumi.AzureNative.StorageSync.Outputs.PrivateEndpointConnectionResponse>
    List of private endpoint connection associated with the specified storage sync service
    ProvisioningState string
    StorageSyncService Provisioning State
    StorageSyncServiceStatus int
    Storage Sync service status.
    StorageSyncServiceUid string
    Storage Sync service Uid
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Id string
    The provider-assigned unique ID for this managed resource.
    LastOperationName string
    Resource Last Operation Name
    LastWorkflowId string
    StorageSyncService lastWorkflowId
    Name string
    The name of the resource
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    List of private endpoint connection associated with the specified storage sync service
    ProvisioningState string
    StorageSyncService Provisioning State
    StorageSyncServiceStatus int
    Storage Sync service status.
    StorageSyncServiceUid string
    Storage Sync service Uid
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperationName String
    Resource Last Operation Name
    lastWorkflowId String
    StorageSyncService lastWorkflowId
    name String
    The name of the resource
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    List of private endpoint connection associated with the specified storage sync service
    provisioningState String
    StorageSyncService Provisioning State
    storageSyncServiceStatus Integer
    Storage Sync service status.
    storageSyncServiceUid String
    Storage Sync service Uid
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id string
    The provider-assigned unique ID for this managed resource.
    lastOperationName string
    Resource Last Operation Name
    lastWorkflowId string
    StorageSyncService lastWorkflowId
    name string
    The name of the resource
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    List of private endpoint connection associated with the specified storage sync service
    provisioningState string
    StorageSyncService Provisioning State
    storageSyncServiceStatus number
    Storage Sync service status.
    storageSyncServiceUid string
    Storage Sync service Uid
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id str
    The provider-assigned unique ID for this managed resource.
    last_operation_name str
    Resource Last Operation Name
    last_workflow_id str
    StorageSyncService lastWorkflowId
    name str
    The name of the resource
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    List of private endpoint connection associated with the specified storage sync service
    provisioning_state str
    StorageSyncService Provisioning State
    storage_sync_service_status int
    Storage Sync service status.
    storage_sync_service_uid str
    Storage Sync service Uid
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    id String
    The provider-assigned unique ID for this managed resource.
    lastOperationName String
    Resource Last Operation Name
    lastWorkflowId String
    StorageSyncService lastWorkflowId
    name String
    The name of the resource
    privateEndpointConnections List<Property Map>
    List of private endpoint connection associated with the specified storage sync service
    provisioningState String
    StorageSyncService Provisioning State
    storageSyncServiceStatus Number
    Storage Sync service status.
    storageSyncServiceUid String
    Storage Sync service Uid
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    IncomingTrafficPolicy, IncomingTrafficPolicyArgs

    AllowAllTraffic
    AllowAllTraffic
    AllowVirtualNetworksOnly
    AllowVirtualNetworksOnly
    IncomingTrafficPolicyAllowAllTraffic
    AllowAllTraffic
    IncomingTrafficPolicyAllowVirtualNetworksOnly
    AllowVirtualNetworksOnly
    AllowAllTraffic
    AllowAllTraffic
    AllowVirtualNetworksOnly
    AllowVirtualNetworksOnly
    AllowAllTraffic
    AllowAllTraffic
    AllowVirtualNetworksOnly
    AllowVirtualNetworksOnly
    ALLOW_ALL_TRAFFIC
    AllowAllTraffic
    ALLOW_VIRTUAL_NETWORKS_ONLY
    AllowVirtualNetworksOnly
    "AllowAllTraffic"
    AllowAllTraffic
    "AllowVirtualNetworksOnly"
    AllowVirtualNetworksOnly

    PrivateEndpointConnectionResponse, PrivateEndpointConnectionResponseArgs

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState Pulumi.AzureNative.StorageSync.Inputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint Pulumi.AzureNative.StorageSync.Inputs.PrivateEndpointResponse
    The resource of private end point.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection resource.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint PrivateEndpointResponse
    The resource of private end point.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState string
    The provisioning state of the private endpoint connection resource.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioning_state str
    The provisioning state of the private endpoint connection resource.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    private_endpoint PrivateEndpointResponse
    The resource of private end point.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection resource.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint Property Map
    The resource of private end point.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    The ARM identifier for Private Endpoint
    Id string
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint
    id string
    The ARM identifier for Private Endpoint
    id str
    The ARM identifier for Private Endpoint
    id String
    The ARM identifier for Private Endpoint

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:storagesync:StorageSyncService SampleStorageSyncService_1 /subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native