Share via

Microsoft.StorageSync storageSyncServices 2020-03-01

Bicep resource definition

The storageSyncServices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorageSync/storageSyncServices resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.StorageSync/storageSyncServices@2020-03-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    incomingTrafficPolicy: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.StorageSync/storageSyncServices

Name Description Value
location 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. string (required)
name The resource name string (required)
properties The parameters used to create the storage sync service. StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates

StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties

Name Description Value
incomingTrafficPolicy Incoming Traffic Policy 'AllowAllTraffic'
'AllowVirtualNetworksOnly'

StorageSyncServiceCreateParametersTags

Name Description Value

ARM template resource definition

The storageSyncServices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorageSync/storageSyncServices resource, add the following JSON to your template.

{
  "type": "Microsoft.StorageSync/storageSyncServices",
  "apiVersion": "2020-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "incomingTrafficPolicy": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.StorageSync/storageSyncServices

Name Description Value
apiVersion The api version '2020-03-01'
location 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. string (required)
name The resource name string (required)
properties The parameters used to create the storage sync service. StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.StorageSync/storageSyncServices'

StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties

Name Description Value
incomingTrafficPolicy Incoming Traffic Policy 'AllowAllTraffic'
'AllowVirtualNetworksOnly'

StorageSyncServiceCreateParametersTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The storageSyncServices resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.StorageSync/storageSyncServices resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.StorageSync/storageSyncServices@2020-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      incomingTrafficPolicy = "string"
    }
  }
}

Property Values

Microsoft.StorageSync/storageSyncServices

Name Description Value
location 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. string (required)
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The parameters used to create the storage sync service. StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.StorageSync/storageSyncServices@2020-03-01"

StorageSyncServiceCreateParametersPropertiesOrStorageSyncServiceProperties

Name Description Value
incomingTrafficPolicy Incoming Traffic Policy 'AllowAllTraffic'
'AllowVirtualNetworksOnly'

StorageSyncServiceCreateParametersTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Storage Sync.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageSyncService" {
  type      = "Microsoft.StorageSync/storageSyncServices@2020-03-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      incomingTrafficPolicy = "AllowAllTraffic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on